[Mono-list] Monodoc - doc generator

Duncan Mak duncan@ximian.com
12 Jul 2003 19:16:13 -0400

On Sat, 2003-07-12 at 11:55, Giuseppe Greco wrote:
> Hi all,
> I've checked out monodoc from CVS and I've seen there is
> a tool named updater.exe in the "generator" directory.
> update.exe takes an assembly as an input and then
> generates XML documentation stubs.
> Does that means that I wouldn't be able to extract
> documentation comments from my C# source files at all?
> Hai! That also means I've to manually move all the
> documentation comments from my C# source files into these
> generated stub files...
> Did the Mono team decide to not implement the -doc option
> for mcs.exe at all, or are there plans for future development?

The doc generator was written because it was decided that we'll build
upon the existing documentation from ECMA. Since the content available
from ECMA is only a subset of what's really available (on top of that we
also have other binding APIs, such as Gtk#), a generator was written to
generate similar XML documentation stubs in the style of the ECMA
documentation for the classes that are not included in original the ECMA

The creation of this generator has really nothing to do with the
compiler's ability to generate documentation from inline comments. If
you do choose to use this ECMA format however, your docs will be
viewable from MonoDoc.