docs: Move documentation to inline comments: gdkdisplay

[~andy/gtk] / gdk / gdkdisplay.c

diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index 2f3050965ad5c1ef5b607a3fd9482ea6a78c3438..1dab470c5d62f26dbc5e590312bff23e91aa0be1 100644 (file)
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -34,6 +34,32 @@
 #include <glib.h>
 #include <math.h>
 
+
+/**
+ * SECTION:gdkdisplay
+ * @Short_description: Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
+ * @Title: GdkDisplay
+ *
+ * #GdkDisplay objects purpose are two fold:
+ * <itemizedlist>
+ * <listitem><para>
+ *   To grab/ungrab keyboard focus and mouse pointer
+ * </para></listitem>
+ * <listitem><para>
+ *   To manage and provide information about the #GdkScreen(s)
+ *   available for this #GdkDisplay
+ * </para></listitem>
+ * </itemizedlist>
+ *
+ * #GdkDisplay objects are the GDK representation of the X Display which can be
+ * described as <emphasis>a workstation consisting of a keyboard a pointing
+ * device (such as a mouse) and one or more screens</emphasis>.
+ * It is used to open and keep track of various #GdkScreen objects currently
+ * instanciated by the application. It is also used to grab and release the keyboard
+ * and the mouse pointer.
+ */
+
+
 enum {
   OPENED,
   CLOSED,