[Mono-list] Monodoc -- Can we use this to document our application?

rus rus@forgecom.co.uk
Thu, 30 Sep 2004 13:45:56 +0100

Hi all

On a related note, I was just wondering.. is there any way of using NDoc
to generate monodoc documentation?

I've used NDoc on a windows C# project before and it's pretty nifty for
producing MSDN style documentation from XML comments in the C# code.

It would be nice to be able to use the same mechanism to produce monodoc
targeted documentation too

Forgecom web applications

On Thu, 2004-09-30 at 13:33, Joshua Tauberer wrote:
> Kevin Francis wrote:
> > We are working on a Mono based application, and would like some way of
> > documenting our work. Can Monodoc be used for this purpose? How?
> To document your own libraries, you mean?  Yes.  Here's the short of it:
> Check out the monodoc module from CVS.  In the tools directory, run 
> make.  The program monodocer is used to generate stub XML documentation 
> files for an assembly (with the --stub and --assembly options), or later 
> update those XML files based on the changes to the assembly (with the 
> --update and --assembly options).
> Then use your favorite text editor or Monodoc to edit the XML files to 
> actually write the documentation.  With Monodoc (from CVS), run it with 
> the --local-edit path/to/docs option to edit the XML files.
> Good luck.  If you have any monodocer comments/suggestions, let me know.