RE: [gtkmm] Re: API documentation: aiming for 100%

[Murray Cumming Comneon com]

 > I would like to clarify whether documentation should commence 
> on all the below mentioned classes in order to avoid 
> duplication of the work if someone is already o the same job.

Yes, please go ahead. I am not aware of anybody who is working on the
documentation of the same classes. Everybody is announcing their work on the
list, so it should be easy to avoid conflicts.
 
> Further, is the format as mentioned below is acceptable to 
> you?

You have not really described a format precisely here:

> > >         and the format we can use for the documentation is-
> > >                 API NAME
> > >                 INPUT PARAMETERS
> > >                 DESCRIPTION
> > >                 OUTPUT

but I am confident that you can look at the existing doxygen comments and do
the same for new documentation.

> Do you need us to give more headers in .h file?

I don't understand that sentence, but again, I don't see any way to be
confused about the task.
 
> We are fully  conversant with Doxygen.

Great.

Murray Cumming
www.murrayc.com
murrayc usa net

> > > In response to your call for documentation of GTKmm 
> classes, below 
> > > are the classes for which we can do the API documentaion.
> > >
> > >             NAMESPACE - GDK
> > >             CLASSES-
> > >                         GC
> > >                         Pixbuf
> > >                         Pixmap
> > >
> > >             NAMESPACE - GLIB
> > >             CLASSES-
> > >                         Thread
> > >                         Thread::Exit
> > >                         Thread::Error
> > >                         Mutex
> > >                         Mutex::Lock
> > >
> > >             NAMESPACE - GTK
> > >             CLASSES -
> > >                          Window
> > >                          Widget
> > >                           FileSelection
> > >
> > >             NAMESPACE- Gnome::Canvas
> > >             CLASSES-
> > >                             Canvas
> > >                             CanvasAA
> > >                             Pixbuf
> >
> > Great.
> >
> > >         and the format we can use for the documentation is-
> > >                 API NAME
> > >                 INPUT PARAMETERS
> > >                 DESCRIPTION
> > >                 OUTPUT
> > >
> > > Please guide me.
> >
> > I am not quite sure what specific help you need. Are you 
> familiar with 
> > the doxygen/javadoc format that we use? Are you not 
> familiar with the 
> > way that gmmproc merges the C docs to generate some doxygen 
> comments 
> > automatically?
> >
> > Murray Cumming
> > www.murrayc.com
> > murrayc usa net
>