[Mono-list] ECMA compliance

Miguel de Icaza miguel@ximian.com
23 Nov 2001 15:10:08 -0500


> This would be awfully nice.  In this case, we have an easy, visual way to
> check sync and see what remains to be documented.  Plus, running various
> offline tasks would be easy as part of the test/qa builds.  Generating
> documentation todo lists or doc coverage counts for various supported
> languages, for example.
> 
> If anybody's interested, I'll try to draft a proposal for a reasonable XML
> DTD/Schema for external API documentation files in the next day or two.

What about using the format that is already being generated by the
Microsoft C# compiler?  Many tools probably will know how to cope with
this.  Using this format would enable us to interoperate with those
tools.

To handle various languages, we could probably just have extra files,
like this:

	Object-en.xml
	Object-es.xml
	Object-fr.xml

Our tool then basically could take a number of inputs:

	1. Assembly to document.
	2. Master document (Documentation object).

Then we can provide an "import documentation" feature, this feature
would just load an existing XML documentation definition and merge it
into our document (examples: including the documentation from ECMA and
including our existing documentation from our class libraries).

Translation would be dealt by creating just another Documentation object
and showing the contents side-by-side with the contents from the Master
english document.

Miguel.