NDoc

From Wikipedia, the free encyclopedia

NDoc

NDoc 1.3.1 displaying empty project
Developer:	Downs, Kackman, et al.
Latest release:	1.3.1 / 25 January 2005
OS:	Cross-platform (?)
Use:	Documentation generator
License:	GNU GPL
Website:	ndoc.sourceforge.net

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

1 How it works
2 Limitations and future development
3 See also
4 See also
5 References
6 External links

[edit] How it works

NDoc uses two sources to generate a 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.

[edit] 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, 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]