Re: Undocumented functions and LSB

[Matthias Clasen <mclasen redhat com>]

On Wed, 2005-09-21 at 16:32 -0700, Banginwar, Rajesh wrote:
> Hi,
> 
>             As has been discussed in earlier posts, LSB desktop
> project is planning on including GTK+ for LSB standardization. As we
> are going through different interfaces and documentations, we find
> many functions are not documented at all. Some of the examples in Glib
> include:
> 
> g_convert_error_quark

The error_quark functions are not documented, because the convention is
to use the corresponding G_CONVERT_ERROR macro, which is documented.

> g_return_if_fail_warning
>
> g_assert_warning

These are just implementation details of the g_return_if_fail() and 
g_assert() macros.

> g_file_error_quark

See above.

> Also, all the *_get_type functions in Pango and GTK are not
> documented. 
> 

Similar to the error_quark functions, these are by convention used
via the corresponding _TYPE macros, which are admittedly not documented
either, at least not individually. The GObject tutorial that has been
merged into the GObject API docs explains the "standard macros" used
for all GObject types.


Matthias