[Mono-list] NDoc? Sandcastle?

[Joshua Tauberer]

Mads Bondo Dydensborg wrote:
> As part of a cross platform development (Mono/Linux & MS/Windows), we need a 
> tool to convert the csc XML into something usuable.
> 
> Now, I understand that ndoc is dead. I assume MS answer (sandcastle) will work 
> on Windows only. So, are there any recommendations for generating 
> documentation from the sources comments? Is the doxygen support for C# 
> generally useful?

Hi,

You can use the monodocer + monodocs2html tools to generate
documentation in HTML.

First convert the /doc xml file into Mono's documentation format:

monodocer --importslashdoc test.xml --assembly test.dll --path xmldocfiles

This creates a directory xmldocfiles with a bunch of files.  You may
need to edit the files immediately in that directory to add a
description of the assembly and descriptions for namespaces.

Convert that to HTML with:

monodocs2html --source xmldocfiles --dest htmldocs

which creates html files in the htmldocs directory.  The default
template isn't pretty, so you will need to customize it.

See: http://mono-project.com/Generating_Documentation

In particular, the section on static HTML documentation.

HTH.  (Btw, patches are most welcome to make Mono's HTML documentation
output look as good as anyone else's...)

-- 
- Joshua Tauberer

http://razor.occams.info

"Strike up the klezmer and start acting like a man. You're
about to have a truth-mitzvah."  -- The Colbert Report

-- 
- Joshua Tauberer

http://razor.occams.info

"Strike up the klezmer and start acting like a man. You're
about to have a truth-mitzvah."  -- The Colbert Report