[Mono-list] API Documentation

Miguel de Icaza miguel@ximian.com
27 May 2002 14:14:31 -0400

Hello JOnathan,

> Would it be a good idea to transfer any source-code XML documentation
> into the appropriate `msc/docs/apidocs/xml/en' file?

I think this is very appropriate.

We should get the documentation effort going again.  During the past few
days, I was developing applications using Mono alone on Linux (when I am
disconnected from the office) and I missed the documentation a lot.

I can always look at the source code, but it is vastly inferior than
being able to read documentation that clearly separates the properties,
methods, constructors, and the description of the class.

> So I wasn't sure if we should start moving the XML documentation into
> the appropriate XML files, removing them from the source code.

We should start doing this, yes.

> Additionally, it would be nice if 
> http://www.go-mono.com/monodoc-xml.html could document the <value> tag. 
> I've seen it used in some of the examples, but I'm not very clear on
> what it's supposed to contain.

I will let other comment on that.

We also need to finish the documentation tool, so people can start
contributing to the docs.