docs: Move documentation to inline comments: gdkdisplay

diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index a05bd1c6999aa0d846504cfb91a740c06f56ae12..3914941720d66d1c20bae98d11872aeb73fef307 100644 (file)
--- a/docs/reference/gdk/tmpl/.gitignore
+++ b/docs/reference/gdk/tmpl/.gitignore
@@ -2,6 +2,7 @@ cairo_interaction.sgml
 colors.sgml
 dnd.sgml
 gdkapplaunchcontext.sgml
+gdkdisplay.sgml
 pixbufs.sgml
 regions.sgml
 windows.sgml

diff --git a/docs/reference/gdk/tmpl/gdkdisplay.sgml b/docs/reference/gdk/tmpl/gdkdisplay.sgml
deleted file mode 100644 (file)
index 57ace89..0000000
--- a/docs/reference/gdk/tmpl/gdkdisplay.sgml
+++ /dev/null
@@ -1,502 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GdkDisplay
-
-<!-- ##### SECTION Short_Description ##### -->
-Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#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>
-</para>
-<para>
-  #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.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GdkDisplay ##### -->
-<para>
-The <structname>GdkDisplay</structname> struct is the GDK representation
-of an X display. All its fields are private and should not be accessed directly. 
-</para>
-
-@Since: 2.2
-
-<!-- ##### SIGNAL GdkDisplay::closed ##### -->
-<para>
-
-</para>
-
-@gdkdisplay: the object which received the signal.
-@arg1: 
-
-<!-- ##### SIGNAL GdkDisplay::opened ##### -->
-<para>
-
-</para>
-
-@gdkdisplay: the object which received the signal.
-
-<!-- ##### FUNCTION gdk_display_open ##### -->
-<para>
-
-</para>
-
-@display_name: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_default ##### -->
-<para>
-
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_name ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_n_screens ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_screen ##### -->
-<para>
-
-</para>
-
-@display: 
-@screen_num: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_default_screen ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_device_manager ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_pointer_ungrab ##### -->
-<para>
-
-</para>
-
-@display: 
-@time_: 
-
-
-<!-- ##### FUNCTION gdk_display_keyboard_ungrab ##### -->
-<para>
-
-</para>
-
-@display: 
-@time_: 
-
-
-<!-- ##### FUNCTION gdk_display_pointer_is_grabbed ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_device_is_grabbed ##### -->
-<para>
-
-</para>
-
-@display: 
-@device: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_beep ##### -->
-<para>
-
-</para>
-
-@display: 
-
-
-<!-- ##### FUNCTION gdk_display_sync ##### -->
-<para>
-
-</para>
-
-@display: 
-
-
-<!-- ##### FUNCTION gdk_display_flush ##### -->
-<para>
-
-</para>
-
-@display: 
-
-
-<!-- ##### FUNCTION gdk_display_close ##### -->
-<para>
-
-</para>
-
-@display: 
-
-
-<!-- ##### FUNCTION gdk_display_is_closed ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_list_devices ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_event ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_peek_event ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_put_event ##### -->
-<para>
-
-</para>
-
-@display: 
-@event: 
-
-
-<!-- ##### FUNCTION gdk_display_add_client_message_filter ##### -->
-<para>
-
-</para>
-
-@display: 
-@message_type: 
-@func: 
-@data: 
-
-
-<!-- ##### FUNCTION gdk_display_set_double_click_time ##### -->
-<para>
-
-</para>
-
-@display: 
-@msec: 
-
-
-<!-- ##### FUNCTION gdk_display_set_double_click_distance ##### -->
-<para>
-
-</para>
-
-@display: 
-@distance: 
-
-
-<!-- ##### FUNCTION gdk_display_get_pointer ##### -->
-<para>
-
-</para>
-
-@display: 
-@screen: 
-@x: 
-@y: 
-@mask: 
-
-
-<!-- ##### FUNCTION gdk_display_get_device_state ##### -->
-<para>
-
-</para>
-
-@display: 
-@device: 
-@screen: 
-@x: 
-@y: 
-@mask: 
-
-
-<!-- ##### FUNCTION gdk_display_get_window_at_pointer ##### -->
-<para>
-
-</para>
-
-@display: 
-@win_x: 
-@win_y: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_window_at_device_position ##### -->
-<para>
-
-</para>
-
-@display: 
-@device: 
-@win_x: 
-@win_y: 
-@Returns: 
-
-
-<!-- ##### STRUCT GdkDisplayPointerHooks ##### -->
-<para>
-A table of pointers to functions for getting quantities related to 
-the current pointer position. Each #GdkDisplay has a table of this type,
-which can be set using gdk_display_set_pointer_hooks().
-</para>
-<para>
-This is only useful for such low-level tools as an event recorder. 
-Applications should never have any reason to use this facility
-</para>
-
-@get_pointer: Obtains the current pointer position and modifier state.
-  The position is given in coordinates relative to the window containing 
-  the pointer, which is returned in @window.
-@window_get_pointer: Obtains the window underneath the mouse pointer.
-  Current pointer position and modifier state are returned in @x, @y and 
-  @mask. The position is given in coordinates relative to @window.
-@window_at_pointer: Obtains the window underneath the mouse pointer, 
-  returning the location of that window in @win_x, @win_y. Returns %NULL 
-  if the window under the mouse pointer is not known to GDK (for example, 
-  belongs to another application).
-@Since: 2.2
-
-<!-- ##### FUNCTION gdk_display_set_pointer_hooks ##### -->
-<para>
-
-</para>
-
-@display: 
-@new_hooks: 
-@Returns: 
-
-
-<!-- ##### STRUCT GdkDisplayDeviceHooks ##### -->
-<para>
-
-</para>
-
-@get_device_state: 
-@window_get_device_position: 
-@window_at_device_position: 
-
-<!-- ##### FUNCTION gdk_display_set_device_hooks ##### -->
-<para>
-
-</para>
-
-@display: 
-@new_hooks: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_warp_pointer ##### -->
-<para>
-
-</para>
-
-@display: 
-@screen: 
-@x: 
-@y: 
-
-
-<!-- ##### FUNCTION gdk_display_warp_device ##### -->
-<para>
-
-</para>
-
-@display: 
-@device: 
-@screen: 
-@x: 
-@y: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_cursor_color ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_cursor_alpha ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_default_cursor_size ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_get_maximal_cursor_size ##### -->
-<para>
-
-</para>
-
-@display: 
-@width: 
-@height: 
-
-
-<!-- ##### FUNCTION gdk_display_get_default_group ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_selection_notification ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_request_selection_notification ##### -->
-<para>
-
-</para>
-
-@display: 
-@selection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_clipboard_persistence ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_store_clipboard ##### -->
-<para>
-
-</para>
-
-@display: 
-@clipboard_window: 
-@time_: 
-@targets: 
-@n_targets: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_shapes ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_input_shapes ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_display_supports_composite ##### -->
-<para>
-
-</para>
-
-@display: 
-@Returns: 
-
-

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,

diff --git a/gdk/gdkdisplay.h b/gdk/gdkdisplay.h
index 1b11b696c7d0322557363f22dbf7bb12b2bb3f9a..17afa4bfc7955d00cf43643f0f86960c678c79cd 100644 (file)
--- a/gdk/gdkdisplay.h
+++ b/gdk/gdkdisplay.h
@@ -132,6 +132,28 @@ struct _GdkDisplayClass
                  gboolean    is_error);
 };
 
+/**
+ * GdkDisplayPointerHooks:
+ * @get_pointer: Obtains the current pointer position and modifier state.
+ *  The position is given in coordinates relative to the screen containing
+ *  the pointer, which is returned in @screen.
+ * @window_get_pointer: Obtains the window underneath the mouse pointer.
+ *  Current pointer position and modifier state are returned in @x, @y and
+ *  @mask. The position is given in coordinates relative to @window.
+ * @window_at_pointer: Obtains the window underneath the mouse pointer,
+ *  returning the location of that window in @win_x, @win_y. Returns %NULL
+ *  if the window under the mouse pointer is not known to GDK (for example,
+ *  belongs to another application).
+ *
+ * A table of pointers to functions for getting quantities related to
+ * the current pointer position. Each #GdkDisplay has a table of this type,
+ * which can be set using gdk_display_set_pointer_hooks().
+ *
+ * This is only useful for such low-level tools as an event recorder.
+ * Applications should never have any reason to use this facility
+ *
+ * Since: 2.2
+ */
 struct _GdkDisplayPointerHooks
 {
   void (*get_pointer)              (GdkDisplay      *display,