GNOME Bugzilla – Bug 123318
Comments in source code not in the gtkdoc format
Last modified: 2009-08-15 18:40:50 UTC
There are numerous comments in the source code that aren't in the format that gtkdoc expects. If some coder is looking for an easy-fix bug, it'd be great if you could submit patches with these comments reformatted so that the information appears in the API docs.
Bug #123360, attachment 20425 [details] [review] provides an example what has to be done.
Bug #125785 will provide more information on gtkdoc
Created attachment 23316 [details] information from gtk-doc-tools
Created attachment 26754 [details] [review] Patch to add gtk-doc comments to most functions This patch adds gtk-doc style comments to most functions. A lot of them are just placeholders with "TODO: Write me", but those are useful, since they're there, in the right format, and when someone is working on a function, they can take a minute to fill in the blanks. A bunch of functions _have_ been documented though (either just from reading them, or from converting existing comments) Also, this has some whitespace changes (deleted places where there were ~10 spurious blank lines at the end of a file), and some formatting changes to function headers (as I threw the comment block on a function, I brought that header more or less into the gnome indentation style, which most of the cong code follows)
Thanks! Looks good, I tested this at my end, though I haven't been able to build the gtk-docs yet. I've committed this to CVS.
The work on bug 144878 (bugreport #144878) allows me to close this bugreport. And being optimistic I choose to use FIXED as status :-P
CLOSED