Top "Documentation" questions

THIS TAG IS FOR DOCUMENT GENERATORS ONLY.

Using automatic documentation of my own function with Qt Creator?

I was using Qt Creator and I decided I wanted to document a function I had written so I positioned …

c++ qt documentation qt-creator
How to interpret API documentation function parameters?

Is there a standard to interpret the syntax of function interfaces in API documentations and if yes, how is it …

api documentation
Offline documentation for various programming languages?

I recently found this: http://php.net/get/php_manual_en.chm/from/a/mirror. It's a .chm file that …

documentation offline
Compare and contrast the lightweight markup languages

Please identify the most popular lightweight markup languages and compare their strengths and weaknesses. These languages should be general-purpose markup …

documentation markdown markup restructuredtext textile
How to create a "dependency graph" for IT assets

One of my customers is trying to create an interactive "matrix" of interdependencies for the various applications used in their …

documentation resources mapping enterprise assets
List of Java Swing UI properties?

There seem to be a ton of UI properties that can be set with UIManager.put("key", value); Is there …

java swing user-interface documentation uimanager
How to document all exceptions a function might throw?

If you have a public function which may throw an exception which uses other (private or public) helper functions which …

c++ exception documentation doxygen
Generate Protobuf documentation?

Does anyone know of a good tool to generate Google Protobuf documentation using the .proto source files?

documentation protocols protocol-buffers documentation-generation
Where is the Python documentation for the special methods? (__init__, __new__, __len__, ...)

Where is a complete list of the special double-underscore/dunder methods that can be used in classes? (e.g., __init__, __…

python class oop documentation magic-methods
Using Doxygen with C, do you comment the function prototype or the definition? Or both?

I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on …

c documentation doxygen documentation-generation