[Mono-list] Re: [Mono-docs-list] WebControls Documentation
Tue, 5 Mar 2002 16:44:57 -0800
Might I suggest using the existing standard format that's generated by
"csc.exe /doc:<filename.xml>" ?
Here's the docs for the 'XML Documentation' feature:
If you use this then you can make use of the already quite large
selection of tools available for managing this stuff. Most notably the
It seems a shame to reinvent the wheel...
Is there any plan to support the '///'-style comments used by csc to
generate this stuff?
From: Miguel de Icaza [mailto:email@example.com
Sent: Tuesday, March 05, 2002 11:39 AM
To: Adam Treat
Cc: Gaurav Vaish; firstname.lastname@example.org; email@example.com
Subject: Re: [Mono-list] Re: [Mono-docs-list] WebControls Documentation
> I hate the idea of this holding up writing external documentation.
> While it
> is true that the tools are not complete, if we can just come up with a
> standard DTD for the external documentation, then maybe we can get
> actually writing the docs. Below is the sample I was using for
> documentation. Another issue to think about is where to put the
The DTD you posted seems good, there are some questions though, how do
you list the various argument that the function takes, and provide
There are a couple of options about placing documentation:
a) Create a `docs' dir on each directory containing source code,
and inside this `docs' directory, create a directory per
language (C, de, es, fr, etc).
So something like:
b) Mirror the hierarchy:
Mono-list maillist - Monofirstname.lastname@example.org