NDoc

NDoc

NDoc 1.3.1 displaying empty project
Developer(s)	Downs, Kackman, et al.
Stable release	1.3.1 / 25 January 2005
Operating system	Cross-platform (?)
Type	Documentation generator
License	GNU GPL
Website	http://ndoc.sourceforge.net

NDoc is a code documentation generator for the Common Language Infrastructure. It is licensed under the GNU General Public License.

How it works

NDoc uses two sources to generate documentation. The first is an assembly file produced by compiling the source code. The other is a pre-generated XML documentation file, usually produced by parsing the source code for special comments (C# compilers from .NET Framework and Mono support this using the "/doc" command-line argument).

The assembly file is queried using reflection to obtain the list of classes, methods, etc. The XML file is parsed for the documentation text.

NDoc supports several different output formats, including CHM, MSDN-style web pages, and Javadoc-style web pages. NDoc also comes with a graphical user interface to ease the generation process.

Limitations and future development

The latest release version of NDoc does not support .NET Framework version 2.0. Although there are internal alpha versions^[1][2] that support .NET 2.0, as of 2006^[update], there is very little activity on the NDoc project. The developer of NDoc, Kevin Downs, has said that he is not working on NDoc anymore due to lack of funding and threats against him, and that he is willing to hand over administration of the project.^[3]. More recently, Kim Christensen picked up the ball and continues development of the original NDoc as NDoc3^[4]

See also

Free software portal

• Doxygen - a mature document generation tool that can also build class diagrams and produce documentation from many other languages.
• Sandcastle — a similar application by Microsoft.
• Sandcastle Help File Builder — a freeware GUI front-end for Sandcastle that provides Ndoc-like features.
• Comparison of documentation generators

References

1. ^ NDoc project stalled, no version for 2.0. What is Microsoft doing? - Fabrice's weblog
2. ^ NDoc 2.0 Alpha
3. ^ John's .NET/SQL Brain Dump: NDoc 2.0 is Dead!
4. ^ NDoc3, successor project of NDoc

External links

• Official website of NDoc
• Website of NDoc3, official successor to NDoc
• NDoc 2005 and NDoc Reloaded — forks of NDoc