GNOME Bugzilla – Bug 729983
gdk: assorted introspection and documentation syntax fixes
Last modified: 2014-05-19 18:55:17 UTC
Created attachment 276358 [details] [review] gdk: assorted introspection and documentation fixes I've ported over some annotations from Vala's metadata files, added some other missing annotations I noticed, added a % or # to some constants and types where appropriate (e.g., NULL->%NULL), etc.
Review of attachment 276358 [details] [review]: Other than that, looks fine ::: gdk/gdkdisplay.c @@ +50,3 @@ * - To manage and provide information about the available #GdkScreens * + * #GdkDisplay objects are the GDK representation of an X Display, This one was intentionally left unlinkified, to avoid 'sea of links' syndrome. @@ +54,3 @@ * a keyboard, a pointing device (such as a mouse) and one or more * screens. + * It is used to open and keep track of various #GdkScreen objects And this too ::: gdk/gdkscreen.c @@ +40,3 @@ * combines several physical monitors (see gdk_screen_get_n_monitors()). * + * #GdkScreen is used throughout GDK and GTK+ to specify which screen This one was intentionally left unlinkified, to avoid 'sea of links' syndrome.
(In reply to comment #1) > Review of attachment 276358 [details] [review]: > @@ +50,3 @@ > * - To manage and provide information about the available #GdkScreens > * > + * #GdkDisplay objects are the GDK representation of an X Display, > > This one was intentionally left unlinkified, to avoid 'sea of links' syndrome. The change isn't really about making them links, it's about cleaning up the docs for languages other than C. Adding the # marks them so that the name can be transformed to match whatever it is in that language (i.e., "Display" or "Gdk.Display" instead of "GdkDisplay").
See http://valadoc.org/gdk-3.0/Gdk.Display.html for an example of what I'm talking about. I've already talked to Florian about fixing #GtkScreens to discard that trailing 's', but note that it talks about GtkDisplay instead of Display. I don't really care about the link, but it's nice for the type name to be correct for whatever language you're using.
Created attachment 276695 [details] [review] gdk: assorted introspection and documentation fixes Here is the same patch without those three changes. I still think the first patch is better.
Review of attachment 276695 [details] [review]: thanks