Jump to content

NDoc: Difference between revisions

From Wikipedia, the free encyclopedia
Browse history interactively
← Previous edit
Content deleted Content added
VisualWikitext
No edit summary
m Replaces obsolete tag
 
(41 intermediate revisions by 29 users not shown)
Line 1: Line 1:
{{distinguish|NDOC (disambiguation)|Ndoc}}
{{Infobox Software
{{Infobox software
| name = NDoc
| name = NDoc
| logo =
| logo =
| screenshot = [[Image:NDoc_1.3.1.png|200px]]
| screenshot = NDoc 1.3.1.png
| screenshot size = 200px
| caption = NDoc 1.3.1 displaying empty project
| caption = NDoc 1.3.1 displaying empty project
| latest_release_version = 1.3.1
| latest_release_version = 1.3.1
| latest_release_date = [[25 January]] [[2005]]
| latest_release_date = 25 January 2005
| developer = Downs, Kackman, et al.
| developer = Diamond, Manoli, et al.
| operating_system = [[Cross-platform]] (?)
| operating_system = [[Cross-platform]] (?)
| genre = [[Documentation generator]]
| genre = [[Documentation generator]]
| license = [[GNU GPL]]
| license = [[GNU GPL]]
| website = http://ndoc.sourceforge.net
| website = {{URL|http://ndoc.sourceforge.net/}}
}}
}}


'''NDoc''' is a code [[documentation generator]] for the [[Common Language Infrastructure]]. It is licensed under the [[GNU General Public License]].
'''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]].


== How it works ==
== How it works ==
⚫
NDoc uses two sources to generate documentation. The first is an [[Assembly (CLI)|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 Sharp (programming language)|C#]] compilers from [[.NET Framework]] and [[Mono (software)|Mono]] support this using the "<code>/doc</code>" command-line argument).

⚫
NDoc uses two sources to generate documentation. The first is an [[.NET assembly|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 Sharp (programming language)|C#]] compilers from [[.NET Framework]] and [[Mono (software)|Mono]] support this using the "<tt>/doc</tt>" command-line argument).


The assembly file is queried using [[Reflection (computer science)|reflection]] to obtain the list of [[Class (computer science)|class]]es, [[Method (computer science)|method]]s, etc. The XML file is parsed for the documentation text.
The assembly file is queried using [[Reflection (computer science)|reflection]] to obtain the list of [[Class (computer science)|class]]es, [[Method (computer science)|method]]s, etc. The XML file is parsed for the documentation text.


NDoc supports several different output formats, including [[Microsoft Compressed HTML Help|CHM]], [[Microsoft Developer Network|MSDN]]-style web pages, and [[Javadoc]]-style web pages. NDoc also comes with a [[graphical user interface]] to ease the generation process.
NDoc uses [[Plug-in (computing)|plug-in]]s to support several different output formats, including [[Microsoft Compressed HTML Help|CHM]], [[Microsoft Help Viewer]], [[Microsoft Developer Network|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 ==
== Limitations and future development ==
⚫
The latest release version of NDoc does not support [[.NET Framework]] version 2.0. Although there are internal [[alpha version]]s<ref>[http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx NDoc project stalled, no version for 2.0. What is Microsoft doing? - Fabrice's weblog<!-- Bot generated title -->]</ref><ref>[http://www.kynosarges.de/NDoc.html NDoc 2.0 Alpha<!-- Bot generated title -->]</ref> that support .NET 2.0, {{As of|2006|lc=on}}, 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.<ref>[https://web.archive.org/web/20060819173307/http://johnsbraindump.blogspot.com/2006/07/ndoc-20-is-dead.html John's .NET/SQL Brain Dump: NDoc 2.0 is Dead!]</ref>

More recently, Kim Christensen picked up the ball and continues development of the original NDoc as NDoc3<ref>[http://ndoc3.sourceforge.net/ NDoc3, successor project of NDoc]</ref>
⚫
The latest release version of NDoc does not support [[.NET Framework]] version 2.0. Although there are internal [[alpha version]]s<ref>[http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx NDoc project stalled, no version for 2.0. What is Microsoft doing? - Fabrice's weblog<!-- Bot generated title -->]</ref><ref>[http://www.kynosarges.de/NDoc.html NDoc 2.0 Alpha<!-- Bot generated title -->]</ref> 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.<ref>[http://johnsbraindump.blogspot.com/2006/07/ndoc-20-is-dead.html John's .NET/SQL Brain Dump: NDoc 2.0 is Dead!<!-- Bot generated title -->]</ref>


== See also ==
== See also ==
{{Portal|Free and open-source software}}
* [[Doxygen]] - a mature document generation tool that can also build class diagrams and produce documentation from many other languages.
⚫
* [[Sandcastle (software)|Sandcastle]] — a similar application by [[Microsoft]].
* [http://shfb.codeplex.com/ Sandcastle Help File Builder] — a freeware GUI front-end for Sandcastle that provides Ndoc-like features.
* [[Visual Expert]] - a [[documentation generator]] that also provides [[Call graph|call trees]], [[Create, read, update and delete|CRUD matrix]], [[Change impact analysis|impact analysis]], [[code review]] for [[PL/SQL]], [[Transact-SQL]] and other languages.
⚫
* [[Comparison of documentation generators]]


⚫
==References==
⚫
* [[SandCastle]] — a new ([[as of 2006]]) similar application by [[Microsoft]]
{{Reflist}}

==See also==
⚫
*[[Comparison of documentation generators]]

⚫
== References ==

<div class="references-small">
<references/>
</div>

⚫
== External links ==


⚫
==External links==
* [http://ndoc.sourceforge.net/ Official website of NDoc]
* [http://ndoc.sourceforge.net/ Official website of NDoc]
* [http://jonas.lagerblad.com/blog/?p=5] — unofficial [[Porting|port]] of NDoc to .NET 2.0
* [http://ndoc3.sourceforge.net/ Website of NDoc3, official successor to NDoc]
* <!-- seems link is broken [http://jonas.lagerblad.com/blog/?p=5] — unofficial [[Porting|port]] of NDoc to .NET 2.0 -->
* [http://sourceforge.net/projects/ndoc05/ NDoc 2005] and [http://sourceforge.net/projects/ndoc-reloaded NDoc Reloaded] — [[fork (software development)|fork]]s of NDoc
* [http://sourceforge.net/projects/ndoc05/ NDoc 2005] and [http://sourceforge.net/projects/ndoc-reloaded NDoc Reloaded] — [[fork (software development)|fork]]s of NDoc


{{DEFAULTSORT:Ndoc}}
[[Category:Free documentation generators]]
[[Category:Free documentation generators]]

{{compu-stub}}

[[da:NDoc]]

Latest revision as of 18:11, 31 August 2020

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

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.

How it works

[edit]

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

[edit]

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]

See also

[edit]

References

[edit]
  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
[edit]
Retrieved from "https://en.wikipedia.org/enwiki/w/index.php?title=NDoc&oldid=976014374"