[Mono-docs-list] Internal Mono VM docs.
Miguel de Icaza
miguel@novell.com
Sun, 12 Dec 2004 21:36:15 -0500
Hey folks,
I have uploaded to:
http://primates.ximian.com/~miguel/tmp/monoapi.tar.gz
A tarball with the docs for the Mono VM internals API, the idea is
to extract the documentation from the source code in Mono. To install
the docs, do this:
tar xzvf monoapi.tar.gz
cp monoapi.* `monodoc --get-sourcesdir`
Notice that currently this requires a node called `embed' to be
defined in monodoc.xml, so you need to edit that (or be using CVS).
In any case, I want to do two things:
* Populate the index for all the "api:xxxx" calls in the HTML
so that it is accessible from monodoc.
* Encourage people to document the public API calls in the Mono
VM.
What I like about the current setup is that API documentation is
merged with a "template" file, so terse explanations, rationale and
others can be organized.
The TOC will probably need to be updated, as soon as I figure out
how to do multi-level docs with the XHTML provider, which seems to be
rather weak error-checking wise.
Miguel.