Re: patch for g_nullify_pointer() and friends

[Owen Taylor <otaylor redhat com>]

Tim Janik <timj gtk org> writes:

> On 6 Aug 2001, Sven Neumann wrote:
> 
> > Hi,
> > 
> > here's a new patch. I stayed with g_nullify_pointer() since I agree
> > with Tim on this subject. The GObject additions are implemented as
> > functions now and are documented inline. Someone should please check 
> > that I found the correct words. The patch also adds a simple test
> > case to testgruntime. There should probably be more tests there...
> 
> a couple minor things:
> for gobject.c and friends, i'd like to avoid inline docs, so please
> add the docs to docs/reference/gobject/tmp/gobject.sgml.

Compare the percentage of functions that are documented in
gobject with the percentage of functions documented elsewhere:
 
 GObject: 20% function coverage
 GLib: 95% function docs coverage.
 Pango: 74% function docs coverage.
 GdkPixbuf: 100% function docs coverage.
 Atk: 100% function docs coverage. 
 GDK: 62% function docs coverage (not using inline docs for everything)
 GTK: 75% function docs coverage.

Please, can we go to inline docs for GObject? They help a _lot_
in making sure that when you add an API point, you document
it, and when you change an entry point, you update the docs.
Something that doesn't seem to be happening in GObject.

Regards,
                                        Owen