From 97bdf55b6d1c61e3242c3308c91920b4ed6fbbf6 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Javier=20Jard=C3=B3n?= <jjardon@gnome.org>
Date: Mon, 4 Oct 2010 03:47:40 +0200
Subject: [PATCH] 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(-)
 delete mode 100644 docs/reference/gdk/tmpl/colors.sgml

diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore
index 029ace620..9c314b991 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/docs/reference/gdk/tmpl/colors.sgml b/docs/reference/gdk/tmpl/colors.sgml
deleted file mode 100644
index 28ce9b8c2..000000000
--- a/docs/reference/gdk/tmpl/colors.sgml
+++ /dev/null
@@ -1,185 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-Colormaps and Colors
-
-<!-- ##### SECTION Short_Description ##### -->
-Manipulation of colors and colormaps
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-These functions are used to modify colormaps.
-A colormap is an object that contains the mapping
-between the color values stored in memory and
-the RGB values that are used to display color
-values. In general, colormaps only contain
-significant information for pseudo-color visuals,
-but even for other visual types, a colormap object
-is required in some circumstances.
-</para>
-
-<para>
-There are a couple of special colormaps that can
-be retrieved. The system colormap (retrieved 
-with gdk_colormap_get_system()) is the default
-colormap of the system. If you are using GdkRGB,
-there is another colormap that is important - the
-colormap in which GdkRGB works, retrieved with
-gdk_rgb_get_colormap(). However, when using GdkRGB, 
-it is not generally necessary to allocate colors
-directly.
-</para>
-
-<para>
-In previous revisions of this interface, a number
-of functions that take a #GdkColormap parameter
-were replaced with functions whose names began
-with "gdk_colormap_".
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GdkColor ##### -->
-<para>
-The #GdkColor structure is used to describe an 
-allocated or unallocated color.
-</para>
-
-@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.
-
-<!-- ##### STRUCT GdkColormap ##### -->
-<para>
-The colormap structure contains the following public fields.
-</para>
-
-
-<!-- ##### FUNCTION gdk_colormap_new ##### -->
-<para>
-</para>
-
-@visual: 
-@allocate: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_colormap_get_system ##### -->
-<para>
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_colormap_alloc_colors ##### -->
-<para>
-</para>
-
-@colormap: 
-@colors: 
-@n_colors: 
-@writeable: 
-@best_match: 
-@success: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_colormap_alloc_color ##### -->
-<para>
-</para>
-
-@colormap: 
-@color: 
-@writeable: 
-@best_match: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_colormap_free_colors ##### -->
-<para>
-</para>
-
-@colormap: 
-@colors: 
-@n_colors: 
-
-
-<!-- ##### FUNCTION gdk_colormap_get_visual ##### -->
-<para>
-</para>
-
-@colormap: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_colormap_get_screen ##### -->
-<para>
-
-</para>
-
-@cmap: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_color_copy ##### -->
-<para>
-</para>
-
-@color: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_color_free ##### -->
-<para>
-</para>
-
-@color: 
-
-
-<!-- ##### FUNCTION gdk_color_parse ##### -->
-<para>
-</para>
-
-@spec: 
-@color: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_color_equal ##### -->
-<para>
-</para>
-
-@colora: 
-@colorb: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_color_hash ##### -->
-<para>
-</para>
-
-@colora: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gdk_color_to_string ##### -->
-<para>
-
-</para>
-
-@color: 
-@Returns: 
-
-
diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index 84416005d..125739903 100644
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -32,6 +32,13 @@
 #include "gdkinternals.h"
 
 
+/**
+ * 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 97da01bf0..4f9ee2af0 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
 {
-- 
2.43.2