[gtk+/treeview-refactor: 241/257] docs: Move documentation to inline comments: gdkcursor

[Tristan Van Berkom <tvb src gnome org>]

commit 1b5f0d596802a7932450c26a02ad4eff7ddd3e38
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Nov 15 16:41:31 2010 +0100

    docs: Move documentation to inline comments: gdkcursor

 docs/reference/gdk/tmpl/.gitignore   |    1 +
 docs/reference/gdk/tmpl/cursors.sgml |  214 ----------------------------------
 gdk/gdkcursor.c                      |   23 ++++
 gdk/gdkcursor.h                      |   93 ++++++++++++++-
 4 files changed, 115 insertions(+), 216 deletions(-)
---
diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index 5b8a121..b3484df 100644
--- a/docs/reference/gdk/tmpl/.gitignore
+++ b/docs/reference/gdk/tmpl/.gitignore
@@ -1,5 +1,6 @@
 cairo_interaction.sgml
 colors.sgml
+cursors.sgml
 dnd.sgml
 gdkapplaunchcontext.sgml
 gdkdisplay.sgml
diff --git a/gdk/gdkcursor.c b/gdk/gdkcursor.c
index 0aabd59..475e96f 100644
--- a/gdk/gdkcursor.c
+++ b/gdk/gdkcursor.c
@@ -32,6 +32,28 @@
 #include "gdkinternals.h"
 
 
+/**
+ * SECTION:cursors
+ * @Short_description: Standard and pixmap cursors
+ * @Title: Cursors
+ *
+ * These functions are used to create and destroy cursors.
+ * There is a number of standard cursors, but it is also
+ * possible to construct new cursors from pixbufs. There
+ * may be limitations as to what kinds of cursors can be
+ * constructed on a given display, see
+ * gdk_display_supports_cursor_alpha(),
+ * gdk_display_supports_cursor_color(),
+ * gdk_display_get_default_cursor_size() and
+ * gdk_display_get_maximal_cursor_size().
+ *
+ * Cursors by themselves are not very interesting, they must be be
+ * bound to a window for users to see them. This is done with
+ * gdk_window_set_cursor() or by setting the cursor member of the
+ * #GdkWindowAttr struct passed to gdk_window_new().
+ */
+
+
 G_DEFINE_BOXED_TYPE (GdkCursor, gdk_cursor,
                      gdk_cursor_ref,
                      gdk_cursor_unref)
@@ -106,5 +128,6 @@ GdkCursorType
 gdk_cursor_get_cursor_type (GdkCursor *cursor)
 {
   g_return_val_if_fail (cursor != NULL, GDK_BLANK_CURSOR);
+
   return cursor->type;
 }
diff --git a/gdk/gdkcursor.h b/gdk/gdkcursor.h
index 91fd6d5..a421828 100644
--- a/gdk/gdkcursor.h
+++ b/gdk/gdkcursor.h
@@ -38,7 +38,91 @@ G_BEGIN_DECLS
 
 #define GDK_TYPE_CURSOR (gdk_cursor_get_type ())
 
-/* Cursor types.
+/**
+ * GdkCursorType:
+ * @GDK_X_CURSOR: <inlinegraphic format="PNG" fileref="X_cursor.png"></inlinegraphic>
+ * @GDK_ARROW: <inlinegraphic format="PNG" fileref="arrow.png"></inlinegraphic>
+ * @GDK_BASED_ARROW_DOWN: <inlinegraphic format="PNG" fileref="based_arrow_down.png"></inlinegraphic>
+ * @GDK_BASED_ARROW_UP: <inlinegraphic format="PNG" fileref="based_arrow_up.png"></inlinegraphic>
+ * @GDK_BOAT: <inlinegraphic format="PNG" fileref="boat.png"></inlinegraphic>
+ * @GDK_BOGOSITY: <inlinegraphic format="PNG" fileref="bogosity.png"></inlinegraphic>
+ * @GDK_BOTTOM_LEFT_CORNER: <inlinegraphic format="PNG" fileref="bottom_left_corner.png"></inlinegraphic>
+ * @GDK_BOTTOM_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="bottom_right_corner.png"></inlinegraphic>
+ * @GDK_BOTTOM_SIDE: <inlinegraphic format="PNG" fileref="bottom_side.png"></inlinegraphic>
+ * @GDK_BOTTOM_TEE: <inlinegraphic format="PNG" fileref="bottom_tee.png"></inlinegraphic>
+ * @GDK_BOX_SPIRAL: <inlinegraphic format="PNG" fileref="box_spiral.png"></inlinegraphic>
+ * @GDK_CENTER_PTR: <inlinegraphic format="PNG" fileref="center_ptr.png"></inlinegraphic>
+ * @GDK_CIRCLE: <inlinegraphic format="PNG" fileref="circle.png"></inlinegraphic>
+ * @GDK_CLOCK: <inlinegraphic format="PNG" fileref="clock.png"></inlinegraphic>
+ * @GDK_COFFEE_MUG: <inlinegraphic format="PNG" fileref="coffee_mug.png"></inlinegraphic>
+ * @GDK_CROSS: <inlinegraphic format="PNG" fileref="cross.png"></inlinegraphic>
+ * @GDK_CROSS_REVERSE: <inlinegraphic format="PNG" fileref="cross_reverse.png"></inlinegraphic>
+ * @GDK_CROSSHAIR: <inlinegraphic format="PNG" fileref="crosshair.png"></inlinegraphic>
+ * @GDK_DIAMOND_CROSS: <inlinegraphic format="PNG" fileref="diamond_cross.png"></inlinegraphic>
+ * @GDK_DOT: <inlinegraphic format="PNG" fileref="dot.png"></inlinegraphic>
+ * @GDK_DOTBOX: <inlinegraphic format="PNG" fileref="dotbox.png"></inlinegraphic>
+ * @GDK_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="double_arrow.png"></inlinegraphic>
+ * @GDK_DRAFT_LARGE: <inlinegraphic format="PNG" fileref="draft_large.png"></inlinegraphic>
+ * @GDK_DRAFT_SMALL: <inlinegraphic format="PNG" fileref="draft_small.png"></inlinegraphic>
+ * @GDK_DRAPED_BOX: <inlinegraphic format="PNG" fileref="draped_box.png"></inlinegraphic>
+ * @GDK_EXCHANGE: <inlinegraphic format="PNG" fileref="exchange.png"></inlinegraphic>
+ * @GDK_FLEUR: <inlinegraphic format="PNG" fileref="fleur.png"></inlinegraphic>
+ * @GDK_GOBBLER: <inlinegraphic format="PNG" fileref="gobbler.png"></inlinegraphic>
+ * @GDK_GUMBY: <inlinegraphic format="PNG" fileref="gumby.png"></inlinegraphic>
+ * @GDK_HAND1: <inlinegraphic format="PNG" fileref="hand1.png"></inlinegraphic>
+ * @GDK_HAND2: <inlinegraphic format="PNG" fileref="hand2.png"></inlinegraphic>
+ * @GDK_HEART: <inlinegraphic format="PNG" fileref="heart.png"></inlinegraphic>
+ * @GDK_ICON: <inlinegraphic format="PNG" fileref="icon.png"></inlinegraphic>
+ * @GDK_IRON_CROSS: <inlinegraphic format="PNG" fileref="iron_cross.png"></inlinegraphic>
+ * @GDK_LEFT_PTR: <inlinegraphic format="PNG" fileref="left_ptr.png"></inlinegraphic>
+ * @GDK_LEFT_SIDE: <inlinegraphic format="PNG" fileref="left_side.png"></inlinegraphic>
+ * @GDK_LEFT_TEE: <inlinegraphic format="PNG" fileref="left_tee.png"></inlinegraphic>
+ * @GDK_LEFTBUTTON: <inlinegraphic format="PNG" fileref="leftbutton.png"></inlinegraphic>
+ * @GDK_LL_ANGLE: <inlinegraphic format="PNG" fileref="ll_angle.png"></inlinegraphic>
+ * @GDK_LR_ANGLE: <inlinegraphic format="PNG" fileref="lr_angle.png"></inlinegraphic>
+ * @GDK_MAN: <inlinegraphic format="PNG" fileref="man.png"></inlinegraphic>
+ * @GDK_MIDDLEBUTTON: <inlinegraphic format="PNG" fileref="middlebutton.png"></inlinegraphic>
+ * @GDK_MOUSE: <inlinegraphic format="PNG" fileref="mouse.png"></inlinegraphic>
+ * @GDK_PENCIL: <inlinegraphic format="PNG" fileref="pencil.png"></inlinegraphic>
+ * @GDK_PIRATE: <inlinegraphic format="PNG" fileref="pirate.png"></inlinegraphic>
+ * @GDK_PLUS: <inlinegraphic format="PNG" fileref="plus.png"></inlinegraphic>
+ * @GDK_QUESTION_ARROW: <inlinegraphic format="PNG" fileref="question_arrow.png"></inlinegraphic>
+ * @GDK_RIGHT_PTR: <inlinegraphic format="PNG" fileref="right_ptr.png"></inlinegraphic>
+ * @GDK_RIGHT_SIDE: <inlinegraphic format="PNG" fileref="right_side.png"></inlinegraphic>
+ * @GDK_RIGHT_TEE: <inlinegraphic format="PNG" fileref="right_tee.png"></inlinegraphic>
+ * @GDK_RIGHTBUTTON: <inlinegraphic format="PNG" fileref="rightbutton.png"></inlinegraphic>
+ * @GDK_RTL_LOGO: <inlinegraphic format="PNG" fileref="rtl_logo.png"></inlinegraphic>
+ * @GDK_SAILBOAT: <inlinegraphic format="PNG" fileref="sailboat.png"></inlinegraphic>
+ * @GDK_SB_DOWN_ARROW: <inlinegraphic format="PNG" fileref="sb_down_arrow.png"></inlinegraphic>
+ * @GDK_SB_H_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_h_double_arrow.png"></inlinegraphic>
+ * @GDK_SB_LEFT_ARROW: <inlinegraphic format="PNG" fileref="sb_left_arrow.png"></inlinegraphic>
+ * @GDK_SB_RIGHT_ARROW: <inlinegraphic format="PNG" fileref="sb_right_arrow.png"></inlinegraphic>
+ * @GDK_SB_UP_ARROW: <inlinegraphic format="PNG" fileref="sb_up_arrow.png"></inlinegraphic>
+ * @GDK_SB_V_DOUBLE_ARROW: <inlinegraphic format="PNG" fileref="sb_v_double_arrow.png"></inlinegraphic>
+ * @GDK_SHUTTLE: <inlinegraphic format="PNG" fileref="shuttle.png"></inlinegraphic>
+ * @GDK_SIZING: <inlinegraphic format="PNG" fileref="sizing.png"></inlinegraphic>
+ * @GDK_SPIDER: <inlinegraphic format="PNG" fileref="spider.png"></inlinegraphic>
+ * @GDK_SPRAYCAN: <inlinegraphic format="PNG" fileref="spraycan.png"></inlinegraphic>
+ * @GDK_STAR: <inlinegraphic format="PNG" fileref="star.png"></inlinegraphic>
+ * @GDK_TARGET: <inlinegraphic format="PNG" fileref="target.png"></inlinegraphic>
+ * @GDK_TCROSS: <inlinegraphic format="PNG" fileref="tcross.png"></inlinegraphic>
+ * @GDK_TOP_LEFT_ARROW: <inlinegraphic format="PNG" fileref="top_left_arrow.png"></inlinegraphic>
+ * @GDK_TOP_LEFT_CORNER: <inlinegraphic format="PNG" fileref="top_left_corner.png"></inlinegraphic>
+ * @GDK_TOP_RIGHT_CORNER: <inlinegraphic format="PNG" fileref="top_right_corner.png"></inlinegraphic>
+ * @GDK_TOP_SIDE: <inlinegraphic format="PNG" fileref="top_side.png"></inlinegraphic>
+ * @GDK_TOP_TEE: <inlinegraphic format="PNG" fileref="top_tee.png"></inlinegraphic>
+ * @GDK_TREK: <inlinegraphic format="PNG" fileref="trek.png"></inlinegraphic>
+ * @GDK_UL_ANGLE: <inlinegraphic format="PNG" fileref="ul_angle.png"></inlinegraphic>
+ * @GDK_UMBRELLA: <inlinegraphic format="PNG" fileref="umbrella.png"></inlinegraphic>
+ * @GDK_UR_ANGLE: <inlinegraphic format="PNG" fileref="ur_angle.png"></inlinegraphic>
+ * @GDK_WATCH: <inlinegraphic format="PNG" fileref="watch.png"></inlinegraphic>
+ * @GDK_XTERM: <inlinegraphic format="PNG" fileref="xterm.png"></inlinegraphic>
+ * @GDK_LAST_CURSOR: last cursor type
+ * @GDK_BLANK_CURSOR: Blank cursor. Since 2.16
+ * @GDK_CURSOR_IS_PIXMAP: type of cursors constructed with
+ *   gdk_cursor_new_from_pixbuf()
+ *
+ * The standard cursors available.
  */
 typedef enum
 {
@@ -124,10 +208,15 @@ typedef enum
   GDK_CURSOR_IS_PIXMAP 	  = -1
 } GdkCursorType;
 
+/**
+ * GdkCursor:
+ *
+ * A #GdkCursor structure represents a cursor.
+ */
 struct _GdkCursor
 {
-  GdkCursorType GSEAL (type);
   /*< private >*/
+  GdkCursorType GSEAL (type);
   guint GSEAL (ref_count);
 };