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

Joshua Tauberer jit at occams.info
Thu Oct 12 08:49:06 EDT 2006

Jonathan Pryor wrote:
> On Wed, 2006-10-11 at 14:08 -0500, Mike Kestner wrote:
>> 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.
> Attached is a patch+unit tests that implements this support.
> Permission to commit?

I'm not exactly enamored with the approach, but if you guys like it, ok...

I guess what bothers me is that the version in which a type/member
appears is very meta-data like (meta-meta-data), automatically
determinable, structured (i.e. in the A.B.C.D format), and consistent
across all types/members introduced in the same version.  The --since
approach excludes the information from the meta-data section of the XML
documents, ignores the fact that it can be automatically determined from
the assembly version, stores the information in a non-structured way
(opaque to other automated processes that might want to do something
based on the info), and introduces necessary redundancy by having the
same user-given string "Version 2.0" distributed throughout all the
types/members that appeared at the same time (which makes it difficult
to revise without a find-replace across files).

- Joshua Tauberer


"Strike up the klezmer and start acting like a man. You're
about to have a truth-mitzvah."  -- The Colbert Report

More information about the Mono-docs-list mailing list