documentation

I have written a pretty extensive REST API using Java Jersey (and JAXB). I have also written the documentation using a Wiki, but its been a totally manual process, which is very error-prone, especially when we need to make modifications, people tend to forget to update the wiki. From looking around, most other REST API's are also manually creating their documentation. But I'm wondering if theres maybe a good solution to this. The kind of things which need to be documented for each endpoint are: Service Name Category URI Parameter Parameter Types Response Types Response Type Schema (XSD) Sample

I'm looking for a way to generate documentation automatically from my Javascript project . Anyone know how can I do this? As far as I know, there're some tools like JSDoc but I want to know your opinion, your best choice and why. Thanks! EDIT: just to be clear, I need something like JavaDOC or PHPDocumentor but to use with my Javascript source code. Raynos There are tools like Natural Docs to do this. I've personally used it in the past and this works fine with javascript. There are also tools like docco to document source code. In general auto generated documentation tends to be too

I started using Sandcastle some time ago to generate a Documentation Website for one of our projects. It's working quite well but we've always only written documentation for classes, methods, properties (...) in our project and had completely separate documentation for the overall project and project parts/modules/namespaces. It would be nice if I could merge that documentation together and add respective documentation to the generated helper files but I can't figure out how to do it. Just adding comments to the namespace declaration doesn't seem to work (C#): /// <summary> /// My short

I'll start with an example. Here's an equivalent of List.fill for tuples as a macro in Scala 2.10: import scala.language.experimental.macros import scala.reflect.macros.Context object TupleExample { def fill[A](arity: Int)(a: A): Product = macro fill_impl[A] def fill_impl[A](c: Context)(arity: c.Expr[Int])(a: c.Expr[A]) = { import c.universe._ arity.tree match { case Literal(Constant(n: Int)) if n < 23 => c.Expr( Apply( Select(Ident("Tuple" + n.toString), "apply"), List.fill(n)(a.tree) ) ) case _ => c.abort( c.enclosingPosition, "Desired arity must be a compile-time constant less than 23!" ) }

I'm looking for the documentation of all the syntax and built-in functions in C, but I can't find any site online which seems like an ultimate official source of standard C knowledge . Apart from the famous book by Kernighan and Ritchie , isn't there any online C specification? Maybe there is, and I don't know how to find it. Or maybe the problem is that I don't exactly know what I'm looking for. You can obtain a PDF copy of the C99 standard (ISO/IEC 9899:1999) from ANSI (and other fine standards organizations) for your private use for a modest fee - I believe it was 18 USD when I bought mine.

I'm trying to create a document out of my module. I used pydoc from the command-line in Windows 7 using Python 3.2.3: python "<path_to_pydoc_>\pydoc.py" -w myModule This led to my shell being filled with text, one line for each file in my module, saying: no Python documentation found for '<file_name>' It's as if Pydoc's trying to get documentation for my files, but I want to autocreate it. I couldn't find a good tutorial using Google. Does anyone have any tips on how to use Pydoc? If I try to create documentation from one file using python ... -w myModule\myFile.py it says wrote myFile.html ,

How to document methods with parameters using Python's documentation strings? EDIT: PEP 257 gives this example: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... Is this the convention used by most Python developers ? Keyword arguments: <parameter name> -- Definition (default value if any) I was expecting something a little bit more formal such as def complex(real=0.0, imag=0.0): """Form a complex number. @param: real The real part

I recently found this: http://php.net/get/php_manual_en.chm/from/a/mirror . It's a .chm file that contains all the documentation for PHP which you can normally find on their site. Handy for offline use. I'm wondering, does anybody know of similar things for other languages. Complete offline documentation that you can use if you don't have wireless for a while. For C#, Visual Studio gives you the option to download and install the entire online documentation as a part of the VS2008 install, so if you have Visual Studio 2008, then you have the C# offline documentation. EDIT: if you're gonna say

The help for Mogenerator is very minimal. What do all the parameters do? Parameters that work both via the command line utility and Xcode: --base-class : The name af the base class which the "private class" (e.g. _MyObject.h ) will inherit from. This will also add an import in the form of #import "MyManagedObject.h" to the same .h file. Tip: if the class you want to inherit from is located in a library, the default import statement won't work. As a workaround, you could have an extra level of inheritance for each project you create and have that class inherit from the library on (e.g. set the