[Mono-docs-list] ECMA-style Documentation Format Changes

Joshua Tauberer tauberer@for.net
Fri, 04 Jul 2003 15:42:16 -0400


I've mentioned this in various emails with less-bold subject lines, so I 
wanted to say this so anyone working on ECMA-style docs knows (anyone 
writing class library documentation):

The monodoc browser displays a lot of things hyperlinked, and to do this 
I needed to add information into the documentation XML files that wasn't 
automatically added when the xml files were generated.

The base class library has the updates, but if you're maintaining any 
other ECMA-style documentation (e.g. Gtk's docs), your XML files need to 
be updated so that monodoc can display everything properly.

The changes to the ECMA format are described here:
http://www.nullenvoid.com/mono/wiki/index.php/ECMAStyleDocumentation

I updated generator.cs so that newly generated files have the proper format.

If you need to have a whole bunch of files updated (e.g. Gtk!), let me 
know and I'll run my updating stylesheet on them and send you or commit 
the differences.

Thanks.

-- 
- Joshua Tauberer

http://taubz.for.net

** Nothing Unreal Exists **