[Mono-docs-list] Re: [Gtk-sharp-list] Documentation effort: Documenting Gtk#

[Duncan Mak]

On Sat, 2003-02-15 at 12:06, Lee Mallabone wrote:
> Please find attached my first attempt at documenting Gtk.Entry.
> 
> Comments, constructive criticism appreciated...
> 

I just started doing some documentation work myself.

A few things:

	* <summary>s, <remarks>s, and most free form text must have 	  <para>
tags.

	* Make use of the <see langword="..."> tag for annotating 	  true/false
in boolean properties.

	* References to Methods, Properties etc, should work the <M:..>, 	 
<P:..> tag.

Other than that, they are perfect!
	
-- 
Duncan Mak <duncan@ximian.com>