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

Lee Mallabone mono-docs@fonicmonkey.net
13 Feb 2003 21:46:49 -0500

On Wed, 2003-02-12 at 15:58, Miguel de Icaza wrote:

>     We have checked into CVS the generated stubs for the Gtk#
> documentation.  These stubs are useful on their own for people who
> to quickly browse the API, but it lacks descriptions and lacks
> examples.  We need volunteers that want to help document Gtk to step
> and help us here.


I took a look at doc/en/Gtk/Entry.xml and started to fill in some of the
"to be added" sections.

However, I noticed there are a lot of virtual functions in the xml.
Should these be present? I'm not sure what to write for them. Any hints?

Similarly, should constructors be documented? More specifically the ones
that only take a handle to the underlying object.

Finally, (for now:), are there any parts that should be documented
first? I'm volunteering to document what I can...