GNOME Bugzilla – Bug 605452
Added more info to "Documenting symbols" sectio
Last modified: 2010-01-11 21:43:33 UTC
I've copied some info from http://live.gnome.org/DocumentationProject/GtkDoc to complete the official documentation
Created attachment 150387 [details] [review] Added more info to "Documenting symbols" sectio I've also reworked the section and use <sect2></sect2> to separate each block
Review of attachment 150387 [details] [review]: ::: help/manual/C/gtk-doc-manual.xml @@ +916,3 @@ + * Deprecated: 2.12: Use foo_baz_get_bar() instead. + **/ +Bar * This would be the correct example (returns is not a parameter) /** * foo_get_bar: * @foo: some foo * * Retrieves @foo's bar. * * Returns: @foo's bar * * Since: 2.6 * * Deprecated: 2.12: Use foo_baz_get_bar() instead. */ @@ +948,3 @@ + </itemizedlist> + </para> + Hmm, for this we should ideally link/describe the gobject introspection annotation tags. Maybe you can add a FIXME and the link to the gnome live wiki. @@ +965,1 @@ * * @...: a %NULL-terminated list of bars "@Varargs:" also works, but imho is not nice to read. @@ +987,3 @@ + </varlistentry> + <varlistentry><term>@Varargs</term> + <listitem> see above.
Created attachment 150757 [details] [review] Added more info to "Documenting symbols" section.v2
Comment on attachment 150757 [details] [review] Added more info to "Documenting symbols" section.v2 Committed with small modifications: - @varargs -> @... + mention @varargs - fix xml validation