Re: [PATCH] small improvements to GLib API docs

[Matthias Clasen <mclasen redhat com>]

On Fri, 2005-09-30 at 12:55 +0800, Davyd Madeley wrote:
> This bit two people yesterday (one of them was me) in wondering how
> g_strchomp and g_strchug actually worked. Did it allocate memory, did it
> return different pointers, would I have to keep another pointer around.
> Stuff like that.
> 
> I added a couple of sentences and some cross referencing (because the
> functions aren't entirely clearly named) in an attempt to clear this up.
> 

Hmm, "Returns: @string" is supposed to convey that the function does not
return any newly allocated memory, but maybe it is a little terse. 

Feel free to commit your doc additions after fixing the grammar ("is
return" should be "is returned").


Regards, Matthias