Re: Lines starting with "returns"



Matthias Clasen <maclas gmx de> writes:

> Here is a patch to fix #65997. It changes the source scanning of gtk-doc
> to ignore lines starting with "returns" when the return value was
> already specified as @returns: in the parameter section. 

What about the template that the commonly used emacs macro
produces:

/**
 * gtk_window_get_title:
 * @window: a #GtkWindow
 *
 * Retrieves the title of the window. See gtk_window_set_title().
 *
 * Return value: the title of the window, or %NULL if none has
 *    been set explicitely. The returned string is owned by the widget
 *    and must not be modified or freed.
 **/

Where the return value is specified as "Return value:" and
after the parameter section. Can we do anything about that?

(Or does it just work since the Return Value: section is after?
Haven't checked recently.)

Regards,
                                        Owen



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]