docs: Move documentation to inline comments: gdkscreen

diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index ba7656b2464770da3afa30581cc85967a29ca2fe..902309a2580bf5c2d5e3d75ab6aac37f40d9cf0f 100644 (file)
--- a/docs/reference/gdk/tmpl/.gitignore
+++ b/docs/reference/gdk/tmpl/.gitignore
@@ -4,6 +4,7 @@ dnd.sgml
 gdkapplaunchcontext.sgml
 gdkdisplay.sgml
 gdkdisplaymanager.sgml
+gdkscreen.sgml
 pixbufs.sgml
 regions.sgml
 windows.sgml

diff --git a/docs/reference/gdk/tmpl/gdkscreen.sgml b/docs/reference/gdk/tmpl/gdkscreen.sgml
deleted file mode 100644 (file)
index a847db9..0000000
--- a/docs/reference/gdk/tmpl/gdkscreen.sgml
+++ /dev/null
@@ -1,397 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GdkScreen
-
-<!-- ##### SECTION Short_Description ##### -->
-Object representing a physical screen
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-  #GdkScreen objects are the GDK representation of a physical screen. It is used 
-  throughout GDK and GTK+ to specify which screen the top level windows
-  are to be displayed on. 
-  It is also used to query the screen specification and default settings such as 
-  the default colormap (gdk_screen_get_default_colormap()),
-  the screen width (gdk_screen_get_width()), etc.
-</para>
-<para>Note that a screen may consist of multiple monitors which are merged to
-form a large screen area. 
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GdkScreen ##### -->
-<para>
-This is a currently just a placeholder typedef for the first argument of 
-the @window_at_pointer function in #GdkPointerHooks. It will be used
-when GDK gets multihead support. 
-</para>
-
-@Since: 2.2
-
-<!-- ##### SIGNAL GdkScreen::composited-changed ##### -->
-<para>
-
-</para>
-
-@gdkscreen: the object which received the signal.
-
-<!-- ##### SIGNAL GdkScreen::monitors-changed ##### -->
-<para>
-
-</para>
-
-@gdkscreen: the object which received the signal.
-
-<!-- ##### SIGNAL GdkScreen::size-changed ##### -->
-<para>
-
-</para>
-
-@gdkscreen: the object which received the signal.
-
-<!-- ##### ARG GdkScreen:font-options ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GdkScreen:resolution ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gdk_screen_get_default ##### -->
-<para>
-
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_system_visual ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_rgba_visual ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_is_composited ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_root_window ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_display ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_number ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_width ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_height ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_width_mm ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_height_mm ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_list_visuals ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_toplevel_windows ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_make_display_name ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_n_monitors ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_primary_monitor ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_geometry ##### -->
-<para>
-
-</para>
-
-@screen: 
-@monitor_num: 
-@dest: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_at_point ##### -->
-<para>
-
-</para>
-
-@screen: 
-@x: 
-@y: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_at_window ##### -->
-<para>
-
-</para>
-
-@screen: 
-@window: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_height_mm ##### -->
-<para>
-
-</para>
-
-@screen: 
-@monitor_num: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_width_mm ##### -->
-<para>
-
-</para>
-
-@screen: 
-@monitor_num: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_monitor_plug_name ##### -->
-<para>
-
-</para>
-
-@screen: 
-@monitor_num: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_broadcast_client_message ##### -->
-<para>
-
-</para>
-
-@screen: 
-@event: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_setting ##### -->
-<para>
-
-</para>
-
-@screen: 
-@name: 
-@value: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_font_options ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_set_font_options ##### -->
-<para>
-
-</para>
-
-@screen: 
-@options: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_resolution ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_set_resolution ##### -->
-<para>
-
-</para>
-
-@screen: 
-@dpi: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_active_window ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_screen_get_window_stack ##### -->
-<para>
-
-</para>
-
-@screen: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_spawn_on_screen ##### -->
-<para>
-
-</para>
-
-@screen: 
-@working_directory: 
-@argv: 
-@envp: 
-@flags: 
-@child_setup: 
-@user_data: 
-@child_pid: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_spawn_on_screen_with_pipes ##### -->
-<para>
-
-</para>
-
-@screen: 
-@working_directory: 
-@argv: 
-@envp: 
-@flags: 
-@child_setup: 
-@user_data: 
-@child_pid: 
-@standard_input: 
-@standard_output: 
-@standard_error: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_spawn_command_line_on_screen ##### -->
-<para>
-
-</para>
-
-@screen: 
-@command_line: 
-@error: 
-@Returns: 
-
-

diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index 25b22d8aef320ab2cb357f97eb39599ab49c548d..57b17ff8803389b57b60caabe82ded4c2852993d 100644 (file)
--- a/gdk/gdkscreen.c
+++ b/gdk/gdkscreen.c
@@ -30,6 +30,22 @@
 #include "gdkintl.h"
 
 
+/**
+ * SECTION:gdkscreen
+ * @Short_description: Object representing a physical screen
+ * @Title: GdkScreen
+ *
+ * #GdkScreen objects are the GDK representation of a physical screen. It is used
+ * throughout GDK and GTK+ to specify which screen the top level windows
+ * are to be displayed on.
+ * It is also used to query the screen specification and default settings such as
+ * the screen width (gdk_screen_get_width()), etc.
+ *
+ * Note that a screen may consist of multiple monitors which are merged to
+ * form a large screen area.
+ */
+
+
 static void gdk_screen_finalize     (GObject        *object);
 static void gdk_screen_set_property (GObject        *object,
                                     guint           prop_id,

diff --git a/gdk/gdkscreen.h b/gdk/gdkscreen.h
index 4b27e6034f4f54be94caeb17236a984de8a466a5..208c4cdc89efdd5b23500893c477dc08cc343a65 100644 (file)
--- a/gdk/gdkscreen.h
+++ b/gdk/gdkscreen.h
@@ -43,6 +43,15 @@ typedef struct _GdkScreenClass GdkScreenClass;
 #define GDK_IS_SCREEN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_SCREEN))
 #define GDK_SCREEN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_SCREEN, GdkScreenClass))
 
+/**
+ * GdkScreen:
+ *
+ * This is a currently just a placeholder typedef for the first argument of
+ * the #GdkPointerHooks.window_at_pointer function in #GdkPointerHooks.
+ * It will be used  when GDK gets multihead support.
+ *
+ * Since: 2.2
+ */
 struct _GdkScreen
 {
   GObject parent_instance;