Top "Documentation-generation" questions

A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files.

How to get Microsoft HTML Help 2 Compiler?

Where can I download the Microsoft HTML Help 2 compiler (or bounding SDK)? I want to generate HTML 2 documentation from my …

documentation-generation sandcastle html-help
What are docstrings called in java?

Before Java methods we have something like: /** * Takes a number and returns its square root. * @param x The value to …

java documentation-generation nomenclature
How do I get a multipage site from GitHub Pages' automatic generator?

I am using the 'Automatic Generator' of GitHub Pages, and I see it only generates a single index.html and …

github markdown documentation-generation github-pages
Should I include getters & setters in class diagram?

I am required to draw a class diagram for my JSF application for a project documentation. So I have lots …

java uml getter-setter class-diagram documentation-generation
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
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
Using Sphinx-apidoc to generate documentation from C++ code

There have been a couple of threads on this topic in the past that claim Sphinx doesn't support this at …

c++ python-sphinx documentation-generation sphinx-apidoc
Objective-C Documentation Generators: HeaderDoc vs. Doxygen vs. AppleDoc

I need to implement a documentation generation solution for my workplace and have narrowed it down to the three mentioned …

doxygen documentation-generation headerdoc appledoc
Has anyone used Sphinx to document a C++ project?

Sphinx is a new documentation tool for Python. It looks very nice. What I'm wondering is: How suitable this is …

python c++ python-sphinx documentation-generation