Wikipedia

Comparison of documentation generators: Difference between revisions

Browse history interactively
← Previous edit
Content deleted Content added
VisualWikitext
Leadum (talk | contribs)
23 edits
Undid revision 105313565 by Robdurbar (talk)
m Removing link(s) Wikipedia:Articles for deletion/Epydoc closed as delete (XFDcloser)
 
(644 intermediate revisions by more than 100 users not shown)
Line 1:
{{Short description|none}}
The following tables compare general and technical information for a number of [[documentation generator]]s. Please see the individual products' articles for further information. This article is not all-inclusive or necessarily up-to-date. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs.
 
The following tables compare general and technical information for a number of [[documentation generator]]s. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. Note that many of the generators listed are no longer maintained.
==General information==
 
Basic general information about the generators: creator/company, license/price etc.
== General information ==
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%;"
Basic general information about the generators, including: creator or company, license, and price.
 
<!-- In each table, link one (often 1st) instance of terms, remove other WP:OVERLINK(s). -->
{| class="wikitable sortable" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center;"
|- style="background: #ececec"
! Name
! style="width:12em" |
! Creator
! Input format
! Languages (alphabet order)
! OS support
! First public release date
! Latest stable version
! Cost ([[United States dollar|USD]])
! [[Software license]]
|-
! style="text-align:left;" bgcolor="#ececec" | [[DBScribe]]Ddoc
| [[Walter Bright]]
| Leadum Software
| Text
| [[2007]]
| 1.1D
| Windows, OS X, Linux and BSD
| from $159, Free for MySQL
| 2005/09/19
| [[Proprietary software|Proprietary]]
| DMD 2.078.3
| {{Free|[[Boost (C++ libraries)|Boost]] (opensource)}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual]docToolchain
| Ralph D. Müller
| Blue Oceans Ltd
| Text
| [[2006]]
| 1.3Java
| Windows, OS X, Linux and BSD
| from $99
| 2018/08/31
| [[Proprietary software|Proprietary]]
| v3.4.2
| {{Free|MIT license}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.comDocument! BI Documenter]X
| Innovasys
| Mienasoft
| Text, Binary
| [[2006]]
| C++/CLI only, C#, IDL, Java, VB, VBScript, PL/SQL
| 1.5
| Windows only
| Free
| 1998
| [[Proprietary software|Proprietary]]
| 2014.1
| {{Nonfree|Proprietary}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdocDoxygen]]
| Dimitri van Heesch
| Jens Gulden
| Text
| [[2001]]
| C/C++, C#, D, IDL, Fortran, Java, PHP, Python
| 1.0
| FreeAny
| 1997/10/26
| [[GNU General Public License|GPL]]
| 1.13.2
| {{Free|GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]Epydoc
| Edward Loper
| Richard Feit
| Text
| [[November 23]], [[1998]]
| 2.3.1Python
| FreeAny
| 2002/01/—
| [[Proprietary software|Proprietary]]
| 3.0 (2008)
| {{Free|[[MIT License|MIT]]}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[DdocFree Pascal|fpdoc]] (Free Pascal Documentation Generator)
| Sebastian Guenther and Free Pascal Core
| [[Walter Bright]]
| Text
| [[September 19]], [[2005]]
| (Object)Pascal/Delphi
| 0.164
| FPC tier 1 targets
| Free
| 2005
| [[GNU General Public License|GPL]]
| 3.2.2
| {{Free|GPL}} reusable parts are GPL with static linking exception
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-MaticHaddock (software)|Haddock]]
| [[Simon Marlow]]
| toolsfactory software inc
| Text
| Nov. 2000
| 4.5Haskell
| Any
| from US$499
| 2002
| [[Proprietary software|Proprietary]]
| 2.15.0 (2014)
|-
| {{Free|BSD}}
! style="text-align:left;" bgcolor="#ececec" | [[Doxygen]]
| [[Dimitri van Heesch]]
| [[1997]]
| 1.5.1
| Free
| [[GNU General Public License|GPL]]
|-
! style="text-align:left;" bgcolor="#ececec" | [[Epydoc]]
| Edward Loper
| [[January]] [[2002]]
| 2.1
| Free
| [[MIT License]]
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDoc]]
| [[Apple ComputerInc.]]
| ?Text
| AppleScript, Bash, Csh, C, C++, Delphi, IDL, Java, JavaScript, MIG, Pascal, Perl, PHP, Python, Ruby, Tcl
| 8
| Any Unix-like
| Free
| 2000/09/—
| [[Apple Public Source License|APSL]]
| 8.9.28 (2013)
| {{Free|[[Apple Public Source License|APSL]]}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com[Imagix Help Generator4D]]
| Imagix Corp.
| Agora Software BV
| Text
| August 2004
| C, C++, Java
| 3.0
| Windows, Linux, Unix
| US$299
| 1995
| [[Proprietary software|Proprietary]]
| 7.3
| {{Nonfree|Proprietary}}
|-
 
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| [[Sun Microsystems]]
| ?Text
| 1.5Java
| Any
| Free (Part of the [[Java 2 SDK]])
| 1995
| [[Proprietary software|Proprietary]]
| 1.6
| {{Free|GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOCJSDoc]]
| Michael Mathews
| Sirtaj Singh Kang
| 1999Text
| JavaScript
| 3.0.1
| FreeAny
| 2001/07/—
| ?
| 1.10.2
| {{Free|GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[JSDoc|JsDoc Toolkit]]
| Michael Mathews
| Text
| JavaScript
| Any
| 2007?
| 2.0.0
| {{Free|MIT}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Mkd (Unix command)|mkd]]
| Jean-Paul Louyot
| Text
| Any with comments
| Unix, Linux, Windows
| 1989
| 2015
| {{Free|[[EUPL]] GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[MkDocs]]
| Tom Christie
| Text
| Python
| Any
| 2014/10/29
| 1.5.3
| {{Free|BSD}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| Greg Valure
| Text
| [[May 26]], [[2003]]
| Any with comments
| 1.35
| FreeAny
| 2003/05/26
| [[GNU General Public License|GPL]]
| 2.0.2
| {{Free|GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| Jason Diamond, Jean-Claude Manoli, Kral Ferch
| Kevin Downs - open source
| Binary
| [[July 27]], [[2003]]
| C#
| Windows only
| 2003/07/27
| 1.3.1
| {{Free|GPL}}
|-
| [[GNU General Public License|GPL]]
! style="text-align:left;" bgcolor="#ececec" | [[pdoc]]
|Andrew Gallant
|Text
|Python
|Any
|2013
|1.0.1 (2021)
| {{Free|[[Unlicense]] (PD)}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Plain Old Documentation|perldoc]]
| [[Larry Wall]]
| Text
| Perl
| Any
| 1994
| 5.16.3
| {{Free|[[Artistic License|Artistic]], GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| Joshua Eichorn
| Text
| [[2000]]
| 1.3.0PHP
| FreeAny
| 2000
| [[GNU Lesser General Public License|LGPL]]
| 3.0.0
| {{Free|[[GNU Lesser General Public License|LGPL]] for 1.x, [[MIT License|MIT]] for 2+}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzerpydoc]]
| Ka-Ping Yee<ref>{{cite web |url=https://peps.python.org/pep-0256/ |title = PEP 256 -- Docstring Processing System Framework {{!}} Python.org}}</ref>
| Aivosto Oy
| Text
| 8.0Python
| Any
| From US$299
| 2000
| [[Proprietary software|Proprietary]]
| in Python core
| {{Free|[[Python Software Foundation License|Python]]}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[RDoc]]
| Dave Thomas
| Text
| C, C++, Ruby
| Any
| 2001/12/14
| in Ruby core
| {{Free|[[Ruby License|Ruby]]}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| Frans Slothouber
| Text
| [[January 19]], [[1995]]
| Any with comments
| 4.99.28
| FreeAny
| 1995/01/19
| [[GNU General Public License|GPL]]
| 4.99.36 (2015)
| {{Free|GPL}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Sandcastle (software)|Sandcastle]]
| [[Microsoft]]
| Text
| .NET
| Windows only
| 2008/05/—
| 2.4.10520 (2016)
| {{Free|[[Shared source#Microsoft Public License .28Ms-PL.29|Ms-PL]]}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Sphinx (documentation generator)|Sphinx]]
| Georg Brandl
| Text
| Ada, C, C++, Chapel, CMake, Fortran, GraphQL, JavaScript, Matlab, PHP, Python, reStructuredText, Ruby, Rust, VB
| Any
| 2008/03/21
| 8.2.1
| {{Free|BSD}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinTextVisual Expert]]
| Novalys
| PTLogica
| Text, Binary
| [[2002]]
| C#, PL/SQL, Transact-SQL, PowerBuilder
| 2.0.325
| Windows only
| US$169
| 1995
| [[Proprietary software|Proprietary]]
| 2017
| {{Nonfree|Proprietary}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocman]]
| Helixoft
| Text
| Oct. 2000
| VB, VBScript, C#
| 2.21
| Windows only
| from US$58
| 2003 Oct 2
| [[Proprietary software|Proprietary]]
| 9.0
| {{Nonfree|Proprietary}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/[YARD VBDOX(software)|YARD]]
| Loren Segal
| Mihayl Stamenov
| Text
| [[October 26]], [[2001]]
| 2.1.0Ruby
| FreeAny
| 2007/02/24
| [[GNU General Public License|GPL]]
| 0.7.3
|- style="background: #ececec"
| {{Free|MIT}}
!
|-
! Name
! Creator
! Input format
! Languages (alphabet order)
! OS support
! First public release date
! Latest stable version
! Cost ([[United States dollar|USD]])
! [[Software license]]
|-
|}
 
== Supported formats ==
==Operating system support==
The [[operating system]]s the generators can run on.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" |
! [[Microsoft Windows|Windows]]
! [[Mac OS X]]
! [[Linux]]
! [[BSD]]
! [[Unix]]
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.com BI Documenter]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Ddoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-Matic]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doxygen]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[Epydoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com Help Generator]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
 
|-
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOC]]
| bgcolor="#ffffdd" | Partial
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzer]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinText]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocman]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/ VBDOX]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|- style="background: #ececec"
!
! [[Microsoft Windows|Windows]]
! [[Mac OS X]]
! [[Linux]]
! [[BSD]]
! [[Unix]]
|-
|}
 
==Language support==
{{sectfact}}
The [[programming language]]s the generators recognize.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" |
! [[C (programming language)|C]]/[[C++]]
! [[Java (programming language)|Java]]
! [[C Sharp|C#]]d
! [[Visual Basic|VB]] / [[VBScript]]
! [[Delphi programming language|Delphi]] / [[Pascal programming language|Pascal]]
! [[Ada programming language|Ada]]
! [[D programming language|D]]
! [[IDL specification language|IDL]]
! [[Microsoft .NET|.NET]]<sup id="fn_1_back">[[#fn 1|1]]
! [[Microsoft Access| Access]]</sup>
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.com BI Documenter]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Ddoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
 
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-Matic]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doxygen]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffffdd" | Partial
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Epydoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com Help Generator]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
 
|-
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOC]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzer]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinText]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffffdd" | Partial
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocman]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/ VBDOX]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|- style="background: #ececec"
!
! [[C (programming language)|C]]/[[C++]]
! [[Java (programming language)|Java]]
! [[C Sharp|C#]]
! [[Visual Basic|VB]] / [[VBScript]]
! [[Delphi programming language|Delphi]] / [[Pascal programming language|Pascal]]
! [[Ada programming language|Ada]]
! [[D programming language|D]]
! [[IDL specification language|IDL]]
! [[Microsoft .NET|.NET]]<sup id="fn_1_back">[[#fn 1|1]]</sup>
|-
|}
 
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" |
! [[PHP]]
! [[Perl]]
! [[Python (programming language)|Python]]
! [[Ruby programming language|Ruby]]
! [[JavaScript]]
! [[ActionScript]]
! [[PL/SQL]]
! [[Tcl]]
! Any With Comments<sup id="fn_2_back">[[#fn 2|2]]</sup>
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.com BI Documenter]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Ddoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
 
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-Matic]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doxygen]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Epydoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOC]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzer]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinText]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocman]]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/ VBDOX]
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|- style="background: #ececec"
!
! [[PHP]]
! [[Perl]]
! [[Python (programming language)|Python]]
! [[Ruby programming language|Ruby]]
! [[JavaScript]]
! [[ActionScript]]
! [[PL/SQL]]
! [[Tcl]]
! Any With Comments<sup id="fn_2_back">[[#fn 2|2]]</sup>
|-
|}
<cite id="fn_1">[[#fn 1 back|Note (1):]]</cite> .NET is not a programming language, but is listed here for convenience.
 
<cite id="fn_2">[[#fn 2 back|Note (2):]]</cite> Generators listed here can be extended to support any language that has comments.
 
==Input formats==
The input formats the generators can read.
{| border="1" cellpadding="1" cellspacing="0" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" |
! [[Plain text|Text]]
! [[Object file|Binary]]
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com/ DB Manual]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.com/ BI Documenter]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Ddoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-Matic]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doxygen]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Epydoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com Help Generator]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOC]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| bgcolor="#ffdddd" | No
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzer]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinText]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocman]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/ VBDOX]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
|- style="background: #ececec"
!
! [[Plain text|Text]]
! [[Object file|Binary]]
|-
|}
 
==Output formats==
The output formats the generators can write.
{| borderclass="1"wikitable cellpadding="1" cellspacing="0sortable" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" | Generator name
! [[HTML]]
! [[Microsoft CompressedCompiled HTML Help|CHM]]
! [[Rich Text Format|RTF]]
! [[Portable Document Format|PDF]]
! [[LaTeX]]
! [[PostScript]]
! [[Unix manual|man pagespage]]s
! [[DocBook]]
! [[XML]]
! [[EPUB]]
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]Ddoc
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ffdddd" | No
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ffdddd" | No
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ffdddd" | No
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}{{efn|name=fn4}}
| bgcolor="#ffdddd" | No
| {{No}}
|- style="background: #
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual[docToolchain]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
|- style="background: #ececec"
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.comDocument! BI Documenter]X
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|- style="background: #ececec"
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdoc]]Epydoc
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn5}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn5}}
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDocFree Pascal|fpdoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| Native
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn5}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn5}}
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[DdocHaddock (software)|Haddock]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| bgcolor="#ffddddffffdd" | NoPartial
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-MaticHeaderDoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[DoxygenImagix 4D]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[EpydocJavadoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn6}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn6}}
| bgcolor="#ddffddffffdd" | YesIndirectly{{efn|name=fn6}}
| bgcolor="#ffffdd" | Indirectly<sup id="fn_3_back">[[#fn {{efn|3]]</sup>name=fn6}}
| bgcolor="#ffffdd" | Indirectly<sup id="fn_3_back2">[[#fn {{efn|3]]</sup>name=fn6}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn6}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn6}}
| bgcolor="#ffddddffffdd" | NoIndirectly{{efn|name=fn6}}
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDocJSDoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com[JSDoc|JsDoc Help GeneratorToolkit]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}+JSON
| bgcolor="#ddffdd" | Yes
| {{No}}
|- style="background: #ececec"
 
|-
! style="text-align:left;" bgcolor="#ececec" | [[Javadoc]]
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
| bgcolor="#ffdddd" | No
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOCMkDocs]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Natural Docs]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[NDoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[pdoc]]
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}} (1.x only)
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}} (1.x only)
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}} (1.x only)
| bgcolor="#ddffdd" | Yes
| {{Yes}} (1.x only)
| bgcolor="#ddffdd" | Yes
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzerpydoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[RDoc]]
| {{Yes}}
| {{Yes}}{{efn|name=fn9}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| bgcolor="#ffffdd" | Indirectly{{efn|name=fn10}}
| {{No}}
| {{Yes}}{{efn|name=fn9}}
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODoc]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffddffffdd" | YesIndirectly
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffddffffdd" | YesIndirectly{{efn|name=fn5}}
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| bgcolor="#ddffddffffdd" | YesIndirectly{{efn|name=fn5}}
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinTextSandcastle (software)|Sandcastle]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocmanSphinx (documentation generator)|Sphinx]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| bgcolor="#ffffdd" | Indirectly{{efn|name=a|Generated from the LaTeX output only}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{Yes}}
| bgcolor="#ffdddd" | No
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/[Visual VBDOXExpert]]
| {{Yes}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ddffdd" | Yes
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
| bgcolor="#ffdddd" | No
| {{No}}
|- style="background: #ececec"
|-
!
! style="text-align:left;" bgcolor="#ececec" | VSdocman
! [[HTML]]
| {{Yes}}
! [[Microsoft Compressed HTML Help|CHM]]
| {{Yes}}
! [[Rich Text Format|RTF]]
| {{No}}
! [[Portable Document Format|PDF]]
| {{Yes}}
! [[LaTeX]]
| {{No}}
! [[PostScript]]
| {{No}}
! [[Unix manual|man pages]]
| {{No}}
! [[DocBook]]
| {{No}}
! [[XML]]
| {{Yes}}
| {{No}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[YARD (software)|YARD]]
| {{Yes}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
| {{No}}
|- class="sortbottom" style="background: #ececec"
! Generator name
! HTML
! CHM
! RTF
! PDF
! LaTeX
! PostScript
! man pages
! DocBook
! XML
! EPUB
|}
<cite id="fn_3">[[#fn 3 back|Note (3):]]</cite> Though not officially supported as an output format, Epydoc uses LaTeX and PostScript as intermediate steps to produce the final PDF documentation.
 
== Other features ==
 
{| borderclass="1"wikitable cellpadding="1" cellspacing="0sortable" style="font-size: 85%; border: gray solid 1px; border-collapse: collapse; text-align: center; width: 100%; table-layout: fixed;"
|- style="background: #ececec"
! style="width:12em" |
Line 1,244 ⟶ 598:
! parameter types extracted
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.leadum.com DBScribe]Ddoc
| bgcolor="#90ff90" | with macros
|
|
|
|
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.dbmanual.com DB Manual[docToolchain]]
| bgcolor="#90ff90" | customizable themes, custom tasks
|
| bgcolor="#90ff90" | many diagram plugins (plantUML, mermaid, ...)
|
| bgcolor="#90ff90" | automatic and manual references, table of contents, bibliography, ...
|
|
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.bidocumenter.comDocument! BI Documenter]X
| bgcolor="#90ff90" | customizable HTML based templates, custom comment tags
|
| bgcolor="#90ff90" | linked graphical object relationship diagrams
|
| bgcolor="#90ff90" | internal links and links to .NET framework documentation
|
| bgcolor="#90ff90" | types extracted and linked
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[classdocDoxygen]]
| bgcolor="#90ff90" | with XSLT
|
| bgcolor="#90ff90" | caller and callee graphs, dependency graphs, inheritance diagrams, collaboration diagrams
|
|
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[CppDoc]]Epydoc
|
|
Line 1,274 ⟶ 628:
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[DdocHaddock (software)|Haddock]]
|
|
|
|
| {{Yes}}
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[Doc-O-MaticHeaderDoc]]
| bgcolor="#90ff90" | Custom headers, footers, code coloring, and other CSS styles in individual pages. Project-wide TOC is generated from a user-defined template.
|
|
|
|
| bgcolor="#90ff90" | Configurable syntax highlighting/coloring with automatic linking to symbols in declaration, ability to manually link to symbols in discussion, etc.
| bgcolor="#90ff90" | Provides warnings if tagged parameters do not match code, parsed parameters included in XML output and Doxygen-style tagfile (-D flag in 8.7). Partial C preprocessor support with -p flag. Support for #if/#ifdef control over documentation inclusion using the -D and -U command-line flags.
|-
! style="text-align:left;" bgcolor="#ececec" | [[DoxygenImagix 4D]]
| bgcolor="#ddffdd90ff90" | withcustomizable XSLTthrough style sheets and CSS
| bgcolor="#ddffdd90ff90" | linked hierarchy and dependency graphs for function calls, variable sets and reads, class inheritance diagramsand interface, collaborationand file includes and interface, intra-function flow diagramscharts
| bgcolor="#90ff90" | fully cross-linked project-wide, including all hierarchy and dependency graphs, metrics tables, source code snippets, and source files
|
| bgcolor="#90ff90" | full semantic analysis of source code, including parameter types, conditional compilation directives, macro expansions
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[EpydocJavadoc]]
|
|
Line 1,298 ⟶ 652:
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[HeaderDocJSDoc]]
|
|
|
|
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [http://www.helpgenerator.com[JSDoc|JsDoc Help GeneratorToolkit]]
|
|
|
|
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[JavadocMkd (Unix command)|mkd]]
| bgcolor="#90ff90" | Customisable for all type of comments
|
| bgcolor="#90ff90" | 'as-is' in comments
|
| bgcolor="#90ff90" | all general documentation; references, manual, organigrams, ... Including the binary codes included in the comments.
|
| bgcolor="#90ff90" | all coded comments
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[KDOC (documentation generator)|KDOCMkDocs]]
|
|
Line 1,334 ⟶ 688:
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentorPlain Old Documentation|perldoc]]
| bgcolor="#ddffdd90ff90" | Smarty-basedExtend templatesthe generator classes through Perl programming.
| bgcolor="#ddffdd" | class inheritance diagrams
| bgcolor="#ddffdd" | cross reference to generated documentation, and to php.net function reference
| bgcolor="#ddffdd" | Yes
|-
! style="text-align:left;" bgcolor="#ececec" | [[Project Analyzer]]
|
| bgcolor="#90ff90" | Only linking
| bgcolor="#ddffdd" | File dependencies, inheritance, control flow, data flow, variable access, class instantiation, data declaration, Form.Show order, procedure calls, project dependencies, file belongs to project, class cohesion.
| bgcolor="#ddffdd" | Cross-referenced source code
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[ROBODocpdoc]]
| bgcolor="#90ff90" | overridable Jinja2 templates
|
|
| bgcolor="#90ff90" | source code syntax highlighting, automatic cross-linking to symbol declarations
|
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[phpDocumentor]]
| bgcolor="#90ff90" | Smarty-based templates (1.x), Twig-based templates (2+)
| bgcolor="#90ff90" | class inheritance diagrams
| bgcolor="#90ff90" | cross reference to generated documentation, and to php.net function reference
| {{Yes}}
|-
! style="text-align:left;" bgcolor="#ececec" | [[TwinTextpydoc]]
|
|
Line 1,358 ⟶ 712:
|
|-
! style="text-align:left;" bgcolor="#ececec" | [[VSdocmanRDoc]]
|
|
Line 1,364 ⟶ 718:
|
|-
! style="text-align:left;" bgcolor="#ececec" | [http://vbdox.sourceforge.net/ VBDOX[ROBODoc]]
|
|
|
|
|- style="background: #ececec"
!
! possibility of extended customization
! generated diagrams
! highlighting and linking of generated doc
! parameter types extracted
|-
! style="text-align:left;" bgcolor="#ececec" | [[Sphinx (documentation generator)|Sphinx]]
| bgcolor="#90ff90" | Customizable themes (10 first-party); Jinja templating; Python plugins
| bgcolor="#90ff90" | class inheritance diagrams, graphviz, third party (e.g. using aafigure, actdiag, Google Chart, gnuplot, mermaid)
| bgcolor="#90ff90" | Automatic cross-referencing (including between projects), Index; Table of Contents, Syntax highlighting with Pygments
| bgcolor="#90ff90" | custom objects (such as functions and classes)
|-
! style="text-align:left;" bgcolor="#ececec" | [[Visual Expert]]
| bgcolor="#90ff90" | documentation content and styles customizable
| bgcolor="#90ff90" | Class inheritance, call trees, dependencies (impact analysis)
| bgcolor="#90ff90" | internal links between classes, methods, variables, tables, columns...
| bgcolor="#90ff90" | all types extracted
|-
! style="text-align:left;" bgcolor="#ececec" | VSdocman
| bgcolor="#90ff90" | full customization for all output formats, templates for MSDN-like output, custom XML comment tags
| bgcolor="#90ff90" | linked graphical class diagrams, class inheritance tree
| bgcolor="#90ff90" | internal links and links to .NET framework documentation
| bgcolor="#90ff90" | types extracted and linked
|-
! style="text-align:left;" bgcolor="#ececec" | [[YARD (software)|YARD]]
| bgcolor="#90ff90" | customizable Ruby templates
| bgcolor="#90ff90" | class diagrams with extra tool
| bgcolor="#90ff90" | internal classes/modules cross-referenced and Ruby source highlighted
|
|}
 
== See also ==
 
* [[Code readability]]
* [[Documentation generator]]
* [[Literate programming]]
* [[Self-documenting code]]
 
==Notes==
{{Notelist|notes=
{{efn|name=fn4|Ddoc has a macro system which can be customized to output any desired format. CHM, groff (manpages), XHTML, XML, and LaTeX (so PostScript and PDF) were tested. They are not currently included in the standard distribution. Standard HTML output also is generated using macros and can be redefined.}}
{{efn|name=fn5|Though not officially supported as an output format, Epydoc uses LaTeX and PostScript as intermediate steps to produce the final PDF documentation.}}
{{efn|name=fn6|Via [[Doclets]] from Third Parties.}}
{{efn|name=fn9|RDoc currently only provides generators for CHM and XML documents in the RDoc version provided as part of the Ruby 1.9 Core.}}
{{efn|name=fn10|RDoc generates documentation for [[RDoc|RI]], which is Ruby's version of the Unix man pages.}}
}}
 
==References==
{{Reflist}}
 
{{DEFAULTSORT:Comparison Of Documentation Generators}}
[[Category:Software comparisons|Documentation generators]]
[[Category:Documentation generators|Software comparison]]
Retrieved from "https://en.wikipedia.org/wiki/Comparison_of_documentation_generators"