Top "Documentation" questions

THIS TAG IS FOR DOCUMENT GENERATORS ONLY.

Doxygen not documenting static classes?

I've been recently using Doxygen for a project of mine. I'm having a problem though that it won't generate the …

c# documentation static doxygen
How can I create .chm files from C# code?

I used doxygen to create HTML files, now I want to convert that documentation into .chm format. How can I …

c# .net documentation chm
Adding a help command to a script

Is there a standard way of adding a help function to a script? The simplest way would maybe to take …

perl documentation command-line-arguments getopt-long perl-pod
Is there a way to define generic types in JS documentation?

I'm looking for documentation generator for my JS library. I find JSDuck the most comprehensive and powerful one. But I …

javascript generics documentation jsdoc jsduck
How to build sphinx documentation for django project

I have a django project, which I document using reST in docstrings to do the following: Help diagloags within IDE …

python django documentation documentation-generation python-sphinx
Should I document my private methods?

Private methods documentation can only be seen by who has access to the source code. Is it worth the effort …

documentation private-members
Are the docs for Struts 1 still available online?

I have needed to maintain a Struts 1 application. I know, EOL almost two years ago, no new releases in six …

documentation struts struts-1
What's the difference on docstrings with triple SINGLE quotes and triple DOUBLE quotes?

I was just wondering what is the difference between two ways of writing Python Docstrings (__doc__): three single quotes: ''' …

python documentation docstring pep
RESTful web service API documentation with Sphinx

What's the best way to markup methods/URLs for a RESTful webservice using ReST/Sphinx? Is there a default domain …

rest documentation python-sphinx
Is 100% code coverage a really good thing when doing unit tests?

I always learned that doing maximum code coverage with unit tests is good. I also hear developers from big companies …

unit-testing documentation tdd code-maintainability