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



commit 97bdf55b6d1c61e3242c3308c91920b4ed6fbbf6
Author: Javier Jardón <jjardon gnome org>
Date:   Mon Oct 4 03:47:40 2010 +0200

    docs: Move documentation to inline comments: colors

 docs/reference/gdk/tmpl/.gitignore  |    1 +
 docs/reference/gdk/tmpl/colors.sgml |  185 -----------------------------------
 gdk/gdkcolor.c                      |    7 ++
 gdk/gdkcolor.h                      |   16 +++-
 4 files changed, 21 insertions(+), 188 deletions(-)
---
diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index 029ace6..9c314b9 100644
--- a/docs/reference/gdk/tmpl/.gitignore
+++ b/docs/reference/gdk/tmpl/.gitignore
@@ -1,4 +1,5 @@
 cairo_interaction.sgml
+colors.sgml
 dnd.sgml
 pixbufs.sgml
 regions.sgml
diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index 8441600..1257399 100644
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -33,6 +33,13 @@
 
 
 /**
+ * SECTION:colors
+ * @Short_description: Manipulation of colors
+ * @Title: Colors
+ */
+
+
+/**
  * gdk_color_copy:
  * @color: a #GdkColor.
  * 
diff --git a/gdk/gdkcolor.h b/gdk/gdkcolor.h
index 97da01b..4f9ee2a 100644
--- a/gdk/gdkcolor.h
+++ b/gdk/gdkcolor.h
@@ -36,9 +36,19 @@
 
 G_BEGIN_DECLS
 
-/* The color type.
- *   A color consists of red, green and blue values in the
- *    range 0-65535 and a pixel value. The pixel value is unused.
+
+/**
+ * GdkColor:
+ * @pixel: For allocated colors, the value used to
+ *  draw this color on the screen.
+ * @red: The red component of the color. This is
+ *  a value between 0 and 65535, with 65535 indicating
+ *  full intensitiy.
+ * @green: The green component of the color.
+ * @blue: The blue component of the color.
+ *
+ * The #GdkColor structure is used to describe an
+ * allocated or unallocated color.
  */
 struct _GdkColor
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]