[Mono-list] Re: [Mono-docs-list] WebControls Documentation

[Miguel de Icaza]

> 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 started 
> actually writing the docs.  Below is the sample I was using for external 
> documentation.  Another issue to think about is where to put the external 
> docs.  

The DTD you posted seems good, there are some questions though, how do
you list the various argument that the function takes, and provide
examples?

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:

	      mcs/
		corlib/
			System/
				docs-es
					Byte.xml

	b) Mirror the hierarchy:

	    mcs/
		class/
			corlib/
				System/
					Byte.cs
		docs/
			corlib/
				System-es/
					Byte.cs

	
Miguel.