Re: minor api issues

[Owen Taylor <otaylor redhat com>]

"Matthias Clasen" <matthiasc poet de> writes:

> While looking through the glib SGML documentation,
> I found a couple of minor API issues:
> 
> 1) the third parameter to GScannerMsgFunc is declared as gint, but should
>    clearly be a gboolean (#61468).

Feel free to change. (Not actually an API issue, really, since
gboolean is a typedef for gint.)
 
> 2) g_scanner_add/remove/foreach_symbol are documented as deprecated,
>     but not guarded by G_DISABLE_DEPRECATED (#61469).

They presumably predate G_DISABLE_DEPRECATED. Go ahead and add
the guards.
 
> 3) The documentation for G_CONST_RETURN says that it should not be
>     used for function arguments, but g_get_charset nevertheless does so.
>     gtk-doc follows the documentation and chokes on the g_get_charset
> prototype
>     (reported as a gtk-doc bug, #61341, but maybe it is really a glib API
> bug).

The documentation for G_CONST_RETURN is a bit wrong.
G_CONST_RETURN _does_ make sense for "out" parameters.

That is:

 void foo (G_CONST_RETURN char *a);

is wrong. But:

 gboolean foo (const char *a, G_CONST_RETURN char **b);

is fine.

Regards,
                                        Owen