documentation-generation

phpDocumentor seems to be the standard for documenting PHP code, though I have to wonder why it hasn't been updated in years..? However, it does not seem suitable for documenting the entry points for a REST API; IE, externally accessible entry points that an end user of your system would be interested in, as opposed to documenting all the internal classes and such - something only of interest to the developers of the api. I am looking for something where I could say, hey this method here is externally accessible through REST at this URL, here's the GET or POST arguments it takes, it supports

I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way to document the c++/cli code to enable its easier use from c# (and within c++/cli of course)? What is you opinion on XML comments vs doxygen vs other tools (which)? Zoinks I have gotten it to work as follows: Use XML style comments for your C++/CLI header entries. This means the full XML comment is required (triple-slash comments, <summary> tag at a

I'm trying to find a tool that generates HTML documentation for my Javascript source code. Does anyone know if the tool that Google uses to generate the interface at the following URLs is open source? Would I be able to generate similar output? http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Serializer.html http://closure-library.googlecode.com/svn/docs/namespace_goog_date.html http://closure-library.googlecode.com/svn/docs/namespace_goog_events.html http://closure-library.googlecode.com/svn/docs/class_goog_gears_Database.html http://closure-library.googlecode.com/svn/docs

When I generate Doxygen documentation in PDF format, I get plenty of different files with a single diagram in each. Is it possible to obtain a single PDF document, organized as a book, roughly as the HTML version? Is it possible to get it automatically, i.e. without dealing manually with the latex files? Thank's! synthesizerpatel See Converting a LaTeX document to a PDF document . When Doxygen is finished processing, in the latex directory there's a file called 'refman.tex'. There are three ways you can use that file to get 'a book' out of Doxygen: LaTeX -> dvips -> ps2pdf latex myfile dvips

I am looking to use Swagger to document my restful interface. The problem is that I do not want to automatically generate my documentation by annotating my code. Basically I don't want to couple my internal data model to the virtual data model exposed by the interface. It appears that I can just have my server provide a Resources.json file and then a corresponding JSON file for each resource handler. However, when I tried this I ran into lots of little gotchas while attempting to define the JSON correct syntax and provide the correct HTTP header response fields. Has anyone used Swagger in this

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

How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, ...}} description syntax and tried it: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of location that should be * returned. Can be either "page", "client" or "screen". * @return {{x: Number, y: Number}} * The location of the event */ var getEventLocation = function(e,

In composer.json I've got { "require": { "phpdocumentor/phpdocumentor": "*" } } It's what is there because I'm trying to install phpDocumentor into an isolated folder with ./composer.phar install command. But what I'm getting is Loading composer repositories with package information Updating dependencies (including require-dev) Your requirements could not be resolved to an installable set of packages. Problem 1 - phpdocumentor/phpdocumentor v2.0.0 requires phpdocumentor/template-abstract ~1.2 -> satisfiable by phpdocumentor/template-abstract[1.2, 1.2.1]. - phpdocumentor/phpdocumentor v2.0.1

I'm wondering if there are any clear reasons to choose UmlGraph over APIViz for javadoc UML diagram generation in a Maven2 build. Are there any integration or features that one has over the other, they seem pretty similar? Pascal Thivent There is an interesting thread here about UMLGraph vs apiviz (which are mentioned in this question on SO too) and my understanding is the following: UMLGraph is older but is really nice (dixit Fowler which has more weight than me). apiviz is a rewrite of UMLGraph but it's not really clear why the rewrote it. The "big" advantage of apiviz is that the build won