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

Carlos Alberto Cortez is118149@mail.udlap.mx
Thu, 13 Feb 2003 17:11:39 -0600 (CST)



Hello there:

I'm a new guy around here. I've seen the anouncement,
so I want to begin writing the Window.xml section, if you don't mind ...

Regards,
Carlos.

On 13 Feb 2003, Lee Mallabone wrote:

> 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
> want
> > to quickly browse the API, but it lacks descriptions and lacks
> > examples.  We need volunteers that want to help document Gtk to step
> up
> > and help us here.
> ..snip..
> 
> Hi,
> 
> 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...
> 
> Regards,
> 
> Lee.
> 
> 
> _______________________________________________
> Mono-docs-list maillist  -  Mono-docs-list@lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-docs-list
>