[Mono-dev] How to include an assembly in mono documentation?

Miguel de Icaza miguel at ximian.com
Thu Jul 27 11:06:21 EDT 2006


Hello,

> I want to add the documentation for the new test framework to the online
> Mono documentation. When I browse the documentation for
> Novel.Directory.Ldap, it looks that it was generated from XML comments.
> Code in mcs\class\System.Web.dotnet\Test\mainsoft\NunitWeb already has
> XML comments, what should I do to make the documentation to appear in
> http://www.go-mono.com/docs/ ?

The documentation that we use in the Mono site uses a different
framework for documentation, we do not use documentation embedded in the
source code.

Instead we use a tool that generates documentation based on the public
API exposed (and that can update the documentation as the API is
updated).

A few samples are in gtk-sharp/docs and monodoc/class

Documentation on this process is here:

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



More information about the Mono-devel-list mailing list