[gtk+] docs: Move documentation to inline comments: gdkscreen

[Javier Jardón <jjardon src gnome org>]

commit 5f89dea7f11fb34d801410abd4b9d6db98dff15b
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Nov 15 03:51:30 2010 +0100

    docs: Move documentation to inline comments: gdkscreen

 docs/reference/gdk/tmpl/.gitignore     |    1 +
 docs/reference/gdk/tmpl/gdkscreen.sgml |  397 --------------------------------
 gdk/gdkscreen.c                        |   16 ++
 gdk/gdkscreen.h                        |    9 +
 4 files changed, 26 insertions(+), 397 deletions(-)
---
diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index ba7656b..902309a 100644
--- 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/gdk/gdkscreen.c b/gdk/gdkscreen.c
index 25b22d8..57b17ff 100644
--- 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 4b27e60..208c4cd 100644
--- 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;