[Mono-list] doctool

[Jonathan Pryor]

On Mon, 2005-01-10 at 04:58 -0600, Francisco T. Martinez wrote:
> lala lalala wrote:
> 
> > is there a doc tool to use like java's javadoc but for mono in linux?
>
> yes.
> 
> MonoDoc

This isn't an entirely useful answer, as MonoDoc isn't anything like
JavaDoc.  MonoDoc is primarily a documentation browser which can edit
ECMA-style XML documentation, meaning that the documentation is kept
separate from the source.

Javadoc, in contrast, has the documentation in the source file and
generates plain HTML which can be viewed by a web browser.

The closer Javadoc equivalent is "mcs /doc", which allows you to insert
XML documentation inside the .cs file, similar to Javadoc.
Unfortunately, "mcs /doc" is only supported in svn-HEAD (and *maybe*
mono 1.1.3), so it's not useful if you need mono 1.0.5.

"Mcs /doc" also isn't useful if you want HTML output, since XML is
generated -- you'd have to either (1) apply a custom XSLT to generate
HTML, or (2) use NDoc to generate the HTML documentation.

See: http://ndoc.sf.net

 - Jon