[Mono-docs-list] Monodocer <since/> support

Mike Kestner mkestner at novell.com
Wed Oct 11 15:08:03 EDT 2006

On Wed, 2006-10-11 at 07:28 -0400, Jonathan Pryor wrote:

> We could just do `--since "Gtk# 2.10"', and all new types/members would
> get a "<since version="Gtk# 2.10" /> element inserted.  It would *only*
> apply to added types/members, and there is no worry about
> checking/comparing assembly versions or anything like that.
> If `--since' isn't provided, then <since/> is never generated.
> This is less "automagic", but it provides more control as well.

I think this is consistent with the role of monodocer, at least as I use
it.  I use monodocer to scan a set of assemblies and adjust a document
catalog by either adding stubs or removing API members.  The --since
option gives me the capability to automatically insert since tags for
new stubs.  That's all I need from monodocer.  It's all anyone will need
if they are starting a catalog from scratch.

The task of adding since tags to existing doc members is outside the
realm of monodocer, in my opinion.  It is a one-time task that is better
served by a single tool like DVP.  We should probably just get it up to
speed with the current monodocer signature code and turn it loose on the
classlib assemblies.  Once they are seeded, monodocer can insert since
tags with new stubs.

I went ahead and checked in DocVersionatorPlus.cs to monodoc/tools in
the event anyone wants to play around with it.

Mike Kestner  <mkestner at novell.com>
SUSE® Linux Enterprise 10
Your Linux is ready™

More information about the Mono-docs-list mailing list