[Mono-docs-list] Proposing a new documentation subsystem

Jonathan Pryor jonpryor at vt.edu
Sun Nov 25 22:05:44 EST 2007

On Sun, 2007-11-25 at 09:28 -0500, Jonathan Pryor wrote:
> The monodocer part should be a fairly minor change, probably < 100 LOC.
> (Probably < 20.)  The browser part will be somewhat more involved,
> mostly as it deals with XSLT, but I don't think it will be terribly
> difficult either.
> Sadly, I'm not sure when I'll get a chance to work on this.  Hopefully
> before year-end.

Attached is a preliminary patch to add this support.  The monodocer
change is 66 lines, and generates output like the attached
Environment.xml.  monodocs2html has also been updated; Environment.html
is the current output.

I should stress that this is a work-in-progress; in particular, it
should (but doesn't) "garbage-collect" the <AssemblyVersion/> elements,
such that if updated assembly 2.0, and a member has an
<AssemblyVersion>2.0</AssemblyVersion> element AND the element has been
REMOVED, the docs are not currently updated to remove this element.
Similar things should be done to ONLY remove a member if e.g. there are
no remaining <AssemblyVersion/> elements (which would likely obsolete
the -ignore_extra_docs parameter if done well).

 - Jon

-------------- next part --------------
A non-text attachment was scrubbed...
Name: assembly-versions.diff
Type: text/x-patch
Size: 3092 bytes
Desc: not available
Url : http://lists.ximian.com/pipermail/mono-docs-list/attachments/20071125/b710f81e/attachment-0002.bin 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Environment.xml
Type: application/xml
Size: 1222 bytes
Desc: not available
Url : http://lists.ximian.com/pipermail/mono-docs-list/attachments/20071125/b710f81e/attachment-0001.rdf 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Environment.html
Type: application/x-mozilla-bookmarks
Size: 4488 bytes
Desc: not available
Url : http://lists.ximian.com/pipermail/mono-docs-list/attachments/20071125/b710f81e/attachment-0003.bin 

More information about the Mono-docs-list mailing list