Monodocer <since/> support
Jonathan Pryor <[email protected]> Tue, 10 Oct 2006 08:44:09 -0400
| Newsgroups | gmane.comp.gnome.mono.documentation |
|---|---|
| Message-ID | <[email protected]> |
Attached is a patch + unit tests which adds Docs/since elements to any type/member which was not present in the previous version. The basic logic is as follows: - If index.xml exists, read all of the /Overview/Assemblies/Assembly elements, and store the found @Name and @Version attributes. - During Type/member processing, check to see if the assembly name this type is from is within the list generated above. If the assembly is found, *and* the version of the current assembly is greater than the assembly version stored above, create a <since/> element with a version attribute containing the current assembly version, e.g. <since version="0.1.0.0" /> Very simple, very braindead, but should be fairly functional, and should allow us to run `monodocer' on the class libs and get <since/> elements generated for all of the types and members that were added in .NET 2.0. ...Except for one minor detail, which is that monodoc/class/corlib/en/index.xml doesn't have any /Overview/Assemblies/Assembly elements. Hmm... Any ideas? We could add the /Overview/Assemblies/Assembly elements to the index.xml files currently within monodoc/class/*/en/. The one thing I *don't* want to do is use the Version information embedded within the Type.xml files. This will allow creation of <since/> elements for members added to that type, but it won't permit generation of <since/> elements for newly added Types (since they won't have a previous file to compare versions with). Alternatively, I could do the above, and always insert <since/> elements for newly created types when the version is not 0.0.0.0... Thanks, - Jon _______________________________________________ Mono-docs-list maillist - [email protected] http://lists.ximian.com/mailman/listinfo/mono-docs-list
monodoc-tools-since.patch.gz
(application/x-gzip, 7.5 KB) - not displayed