[Mono-docs-list] Monodocer for multiple assemblies

Mike Kestner mkestner at novell.com
Sun May 22 18:53:40 EDT 2005

Attached is a first pass attempt at adding multiple assembly support to
monodocer.  I need support for this in order to transition Gtk# to using
monodocer instead of the mkfork of the old updater that we've been
nursing along in gtk-sharp/doc/updater.

With this patch, I can invoke as such:

monodocer -path:en -assembly=glib-sharp.dll,pango-sharp.dll,etc...

which lets me do a comprehensive update of the Gtk# doc catalog.

Known warts/issues:
 - the index document layout has to change to support multiple
assemblies.  The patch supports stubbing for an
<assemblies><assembly><attrs>... layout, but I'm unsure if this is the
way to go.  I think this index file is only used for the docs2html
translation, so I need input on the desired layout.
 - The index assembly attr updating is broken. I decided not to waste
time on this until I had a better feeling for how they are used and what
they should look like.
 - DoUpdateNamespace just looks in the first assembly supplied. I'm
uncertain what the typical use case is for this so it's unclear whether
we should support multiple assembly namespace updating.

I'm a little concerned about the volume of information that monodocer
puts on the console.  It would be nice if "Updating Foo" was only
written to the Console if Foo has changes.

Also, when members are to be deleted but --delete is not specified,
would it be okay to add a "Deprecated" attr like the old updater used to
do.  This is nice to have in practice when, for example, we are updating
method signatures because the old signature was incorrect, but there are
good docs to be moved over to the new signature.

I look forward to comments.

Mike Kestner <mkestner at novell.com>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: monodocer.diff
Type: text/x-patch
Size: 8306 bytes
Desc: not available
Url : http://galactus.ximian.com/pipermail/mono-docs-list/attachments/20050522/573c42bf/monodocer.bin

More information about the Mono-docs-list mailing list