Talk:Comparison of documentation generators

This is the talk page for discussing improvements to the Comparison of documentation generators article.
This is not a forum for general discussion of the article's subject.

Put new text under old text. Click here to start a new topic.
New to Wikipedia? Welcome! Learn to edit; get help.

Article policies

Find sources: Google (books · news · scholar · free images · WP refs) · FENS · JSTOR · TWL

Computing: Software Unassessed

	This article is within the scope of WikiProject Computing, a collaborative effort to improve the coverage of computers, computing, and information technology on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.ComputingWikipedia:WikiProject ComputingTemplate:WikiProject ComputingComputing
???	This article has not yet received a rating on Wikipedia's content assessment scale.
???	This article has not yet received a rating on the project's importance scale.
	This article is supported by WikiProject Software.

Here are some tasks awaiting attention:

Article requests : classdoc, CppDoc, KDOC (documentation generator), VBDOX
Cleanup : Language support table (discriminate between Yes and Partial)
Expand : Include in table Document! X, Eiffeldoc, HappyDoc, JDiff, PHPDoc, WEB
Stubs : Documentation generator, Doc-O-Matic, Doxygen, HeaderDoc, Natural Docs, ROBODoc, TwinText, VBdocman
Update : General information (periodically)

Other language

It seem that none of the software support Unix Shell Scripts, there should be some ? --RzR 14:19, 19 January 2007 (UTC)[reply]

ROBODoc can be configured to support it. --Thuffir Hawat 14:10, 26 September 2007 (UTC)[reply]

I found that Natural Docs supports Flash AS2 and AS3, should we add another table of supported languages and start it off with AS2 and AS3 columns? 98.207.17.2 (talk) 17:32, 22 November 2008 (UTC)[reply]

ROBODoc language support, disputed

Does ROBODoc support ActionScript? Its website doesn't say it does [1] and Google doesn't return anything relevant. 137.48.130.200 23:04, 24 April 2006 (UTC)[reply]

ROBODoc can be configured to support virtually any language that allows remarks --Thuffir Hawat 14:13, 26 September 2007 (UTC)[reply]

Sphinx

Sphinx [2] looks promising. —Preceding unsigned comment added by 76.10.173.10 (talk) 07:31, 30 June 2008 (UTC)[reply]

Language support, Yes vs. Partial?

What is the difference between Yes and Partial on the Language support table, or is it even defined? For example, I've been using Natural Docs since 2003. To me, full language support means that the parser itself can recognize the syntax for functions and classes of a particular language (in this case ActionScript 2.0, C#, and Perl) while partial language support means that it can only recognize the comment style. Perhaps this is defined differently for a Doxygen user, however... 68.226.61.4 06:22, 25 April 2006 (UTC)[reply]

Perhaps we could add a fourth yellow choice called "Manual" which refers to systems (like Natural Docs without full language support) that only accepts things you write for it. I suspect ROBODoc and TwinText are the same way as they're Yes for almost everything as well. A note can be added underneath explaining what it means. I think DDoc might be manual too, even though it's only one language, but I'm not sure. All the generators will have to be checked for the update to make it fair. Greg10101 19:27, 27 May 2006 (UTC)[reply]

I believe theoretically ROBODoc can be configured to recognize any language. I also wholeheartedly agree that a link to the manual in these tables would be a nice, helpful addition. john factorial 21:22, 14 November 2006 (UTC)[reply]

Table of Apps from 2003 to Sync

The present article looks remarkably like the table I assembled and announced in 2003. I wonder if the article was based on my table; comparison would tell.

My team ended up writing custom VB.NET code to convert our C++ API sources to C# to compile in Visual Studio and then, we customized nDoc XSLT to produce an MSDN-style .chm file. This approach enabled storing documentation in the C++ API source code using the C# /// XML markup, which is good because standard -- however, I came to prefer the more stripped-down syntax like Javadoc instead of needlessly verbose angle-brackets. Visual Studio compensates by constructing the initial tagging, but still, that tagging is clunky-looking and verbose.

The present article needs to be checked against my table:

http://www.hypertextnavigation.com/autodoctools.htm

-- user: MichaelSHoffman, Aug. 8 2006

This article is missing the SandCastle Tool from Microsoft.

131.107.0.73 16:36, 11 April 2007 (UTC) Paul Chapman (MSFT), Apr 11, 2007[reply]

Merging

I can't see any value to keeping a seperate List of documentation generators article. Merge the (few) entries from there that aren't in this article, and redirect to here. -- RoySmith (talk) 18:37, 29 August 2006 (UTC)[reply]

Support Redundancy, overlap. Tuxide 17:17, 15 September 2006 (UTC)[reply]
Support Merge and redirect as the list is fully detailed, with notes and comparisons being more suited to this article. Ansell 22:52, 6 November 2006 (UTC)

Notes on DDoc

Hi, I'm using DDoc, and as i remember it's not GPL. DMD (Digital Mars D) compiler which is also used to produce documentation is freeware, but not GPL. There exist GDC (GNU D Compiler) and it supports DDoc, but its autor is David Friedman.

DMD is supported on Windows and Linux x86. GDC on Windows, Linux, Mac OSX, BSD, and AIX

Latest stable version is DMD 1.010

DDoc have very extensible macro system, and easly can be extended (by user) to produce CHM (there exist third party solution for free), man pages (also), SGML, XML, RTF. Standard HTML output also can be completly changed (it is set of templates which can be redefined).

Table colors

What's up with the custom table colors used on this page? Anyone else besides me think these should be changed to the standard wikitable colors? I think that change would make the document more readable, if nothing else. Wrldwzrd89^talk 20:32, 15 August 2007 (UTC)[reply]

I went ahead and fixed the table colors to be more standard. I think it's easier to tell Yes entries from No entries, now. Wrldwzrd89^talk 17:11, 7 February 2008 (UTC)[reply]

Important tags overview

It would be nice to have an overview of important tags or tagging conventions. It might be possible e.g. to note Doxygen tags in a form understandable to Javadoc, too (when using @ instead of the backslash as a prefix). --Tobias (talk) 16:02, 10 June 2008 (UTC)[reply]

Include Litterate programming?

Should we include litterate programming tools to the article? If so, perhaps we also need to add keys for it, for example "allows non-compiler order code", because that is the selling point of the litterate programing practice. It would also differentiate litterate programming tools from the pure documentation tools. —Preceding unsigned comment added by 60.229.115.177 (talk) 12:31, 14 February 2009 (UTC)[reply]