GNOME Bugzilla – Bug 695641
Make the API docs a bit more complete and pretty
Last modified: 2013-03-14 23:42:56 UTC
Not much meat yet, but should pave the way for more.
Created attachment 238597 [details] [review] Improve a bit the look of the main page of the API docs
Created attachment 238598 [details] [review] Add overview and running sections to API docs
Created attachment 238599 [details] [review] Enable tests for the gtk-doc generation
Created attachment 238600 [details] [review] Add a meaningful name and description to all sections/files in the API docs
This is the result, after applying these patches and those in bug 676856: http://people.collabora.com/~tomeu/mutter-docs/
Review of attachment 238597 [details] [review]: Looks good to me.
Review of attachment 238598 [details] [review]: Minor comments: ::: doc/reference/mutter-overview.xml @@ +7,3 @@ + <para>Mutter is a GObject-based library for creating compositing window managers.</para> + + <para>Compositors that wish to use Mutter must implement a subclass of #MetaPlugin and register it with meta_plugin_manager_set_plugin_type() before calling meta_init() but after g_type_init().</para> There's no g_type_init() anymore...but it doesn't hurt too much to leave this in. ::: doc/reference/running-mutter.xml @@ +84,3 @@ + <term>MUTTER_WM_CLASS_FILTER</term> + <listitem> + <para>Comma-separated list of WM_CLASS names to which to restrict Mutter to.</para> Phrasing is awkward here; how about: Mutter will only manage windows whose WM_CLASS is in this comma-separated list.
Review of attachment 238599 [details] [review]: Sure.
Review of attachment 238600 [details] [review]: Nice improvement!
Thanks a lot for the reviews, I will push them with the suggested changes as soon as the ones in bug 676856 are reviewed.
Attachment 238597 [details] pushed as 460dc9f - Improve a bit the look of the main page of the API docs Attachment 238598 [details] pushed as 00a842f - Add overview and running sections to API docs Attachment 238599 [details] pushed as 69c72eb - Enable tests for the gtk-doc generation Attachment 238600 [details] pushed as 2efed44 - Add a meaningful name and description to all sections/files in the API docs