NDoc

NDoc is a code documentation generator for the Common Language Infrastructure created by Jason Diamond, Jean-Claude Manoli and Kral Ferch. It is licensed under the GNU General Public License.

Not to be confused with NDOC (disambiguation) or Ndoc.
NDoc
NDoc 1.3.1 displaying empty project
Developer(s)Diamond, Manoli, et al.
Stable release
1.3.1 / 25 January 2005
Operating systemCross-platform (?)
TypeDocumentation generator
LicenseGNU GPL
Websitendoc.sourceforge.net

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 uses plug-ins to support several different output formats, including CHM, Microsoft Help Viewer, MSDN-style web pages. Incomplete plug-ins are also included as starting points for developers, like the LaTeX plug-in and Javadoc-style web pages. NDoc 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, 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]

gollark: Well, a better metric might be median % of income donated or something, but I don't know where to get that.
gollark: It would be interesting to see how much of this charity spending is going to nearby or further away causes.
gollark: How tabular.
gollark: Going to check UK next.
gollark: Hmm, apparently US per capita charity donations by individuals are something like $1000/year, which is significantly higher than I thought.

See also

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
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.