[gimp] libgimpconfig: move docs from template files to inline comments



commit 1af54c7874db63810b57204fad8813bf2d8ee3b5
Author: Michael Natterer <mitch gimp org>
Date:   Tue Jun 29 20:57:52 2010 +0200

    libgimpconfig: move docs from template files to inline comments

 devel-docs/libgimpconfig/.gitignore                |    1 +
 devel-docs/libgimpconfig/tmpl/.gitignore           |    2 -
 devel-docs/libgimpconfig/tmpl/gimpcolorconfig.sgml |  110 --------
 .../libgimpconfig/tmpl/gimpconfig-deserialize.sgml |   42 ---
 .../libgimpconfig/tmpl/gimpconfig-error.sgml       |   45 ----
 .../libgimpconfig/tmpl/gimpconfig-iface.sgml       |  142 ----------
 .../libgimpconfig/tmpl/gimpconfig-params.sgml      |  275 --------------------
 devel-docs/libgimpconfig/tmpl/gimpconfig-path.sgml |   98 -------
 .../libgimpconfig/tmpl/gimpconfig-serialize.sgml   |   73 -----
 .../libgimpconfig/tmpl/gimpconfig-utils.sgml       |   68 -----
 devel-docs/libgimpconfig/tmpl/gimpconfigtypes.sgml |   28 --
 .../libgimpconfig/tmpl/gimpconfigwriter.sgml       |  166 ------------
 devel-docs/libgimpconfig/tmpl/gimpscanner.sgml     |  139 ----------
 libgimpconfig/gimpcolorconfig.c                    |    9 +
 libgimpconfig/gimpconfig-deserialize.c             |    9 +
 libgimpconfig/gimpconfig-error.c                   |    9 +
 libgimpconfig/gimpconfig-iface.c                   |    9 +
 libgimpconfig/gimpconfig-params.h                  |    9 +
 libgimpconfig/gimpconfig-path.c                    |    9 +
 libgimpconfig/gimpconfig-serialize.c               |    9 +
 libgimpconfig/gimpconfig-utils.c                   |    9 +
 libgimpconfig/gimpconfigwriter.c                   |   10 +
 libgimpconfig/gimpscanner.c                        |    9 +
 23 files changed, 92 insertions(+), 1188 deletions(-)
---
diff --git a/devel-docs/libgimpconfig/.gitignore b/devel-docs/libgimpconfig/.gitignore
index 6a7b928..8b6843c 100644
--- a/devel-docs/libgimpconfig/.gitignore
+++ b/devel-docs/libgimpconfig/.gitignore
@@ -12,6 +12,7 @@
 /libgimpconfig-undeclared.txt
 /libgimpconfig-undocumented.txt
 /html
+/tmpl
 /xml
 /version
 /.libs
diff --git a/libgimpconfig/gimpcolorconfig.c b/libgimpconfig/gimpcolorconfig.c
index 5a03a31..db53832 100644
--- a/libgimpconfig/gimpcolorconfig.c
+++ b/libgimpconfig/gimpcolorconfig.c
@@ -37,6 +37,15 @@
 #include "libgimp/libgimp-intl.h"
 
 
+/**
+ * SECTION: gimpcolorconfig
+ * @title: GimpColorConfig
+ * @short_description: Color management settings.
+ *
+ * Color management settings.
+ **/
+
+
 #define COLOR_MANAGEMENT_MODE_BLURB \
   N_("Mode of operation for color management.")
 #define DISPLAY_PROFILE_BLURB \
diff --git a/libgimpconfig/gimpconfig-deserialize.c b/libgimpconfig/gimpconfig-deserialize.c
index 13251fa..8de3e69 100644
--- a/libgimpconfig/gimpconfig-deserialize.c
+++ b/libgimpconfig/gimpconfig-deserialize.c
@@ -39,6 +39,15 @@
 #include "libgimp/libgimp-intl.h"
 
 
+/**
+ * SECTION: gimpconfig-deserialize
+ * @title: GimpConfig-deserialize
+ * @short_description: Deserializing code for libgimpconfig.
+ *
+ * Deserializing code for libgimpconfig.
+ **/
+
+
 /*
  *  All functions return G_TOKEN_RIGHT_PAREN on success,
  *  the GTokenType they would have expected but didn't get
diff --git a/libgimpconfig/gimpconfig-error.c b/libgimpconfig/gimpconfig-error.c
index c1a119e..c5b953d 100644
--- a/libgimpconfig/gimpconfig-error.c
+++ b/libgimpconfig/gimpconfig-error.c
@@ -27,6 +27,15 @@
 
 
 /**
+ * SECTION: gimpconfig-error
+ * @title: GimpConfig-error
+ * @short_description: Error utils for libgimpconfig.
+ *
+ * Error utils for libgimpconfig.
+ **/
+
+
+/**
  * gimp_config_error_quark:
  *
  * This function is never called directly. Use GIMP_CONFIG_ERROR() instead.
diff --git a/libgimpconfig/gimpconfig-iface.c b/libgimpconfig/gimpconfig-iface.c
index 4671a35..39d50d5 100644
--- a/libgimpconfig/gimpconfig-iface.c
+++ b/libgimpconfig/gimpconfig-iface.c
@@ -40,6 +40,15 @@
 #include "libgimp/libgimp-intl.h"
 
 
+/**
+ * SECTION: gimpconfig-iface
+ * @title: GimpConfig-iface
+ * @short_description: High-level API for libgimpconfig.
+ *
+ * High-level API for libgimpconfig.
+ **/
+
+
 /*
  * The GimpConfig serialization and deserialization interface.
  */
diff --git a/libgimpconfig/gimpconfig-params.h b/libgimpconfig/gimpconfig-params.h
index 4db0cd7..e1ed04d 100644
--- a/libgimpconfig/gimpconfig-params.h
+++ b/libgimpconfig/gimpconfig-params.h
@@ -27,6 +27,15 @@ G_BEGIN_DECLS
 /* For information look into the C source or the html documentation */
 
 
+/**
+ * SECTION: gimpconfig-params
+ * @title: GimpConfig-params
+ * @short_description: Macros and defines to install config properties.
+ *
+ * Macros and defines to install config properties.
+ **/
+
+
 /*
  * GIMP_CONFIG_PARAM_SERIALIZE - A property that can and should be
  *                               serialized and deserialized.
diff --git a/libgimpconfig/gimpconfig-path.c b/libgimpconfig/gimpconfig-path.c
index 48951d1..cc94be1 100644
--- a/libgimpconfig/gimpconfig-path.c
+++ b/libgimpconfig/gimpconfig-path.c
@@ -35,6 +35,15 @@
 
 
 /**
+ * SECTION: gimpconfig-path
+ * @title: GimpConfig-path
+ * @short_description: File path utilities for libgimpconfig.
+ *
+ * File path utilities for libgimpconfig.
+ **/
+
+
+/**
  * gimp_config_path_get_type:
  *
  * Reveals the object type
diff --git a/libgimpconfig/gimpconfig-serialize.c b/libgimpconfig/gimpconfig-serialize.c
index b844368..62448e9 100644
--- a/libgimpconfig/gimpconfig-serialize.c
+++ b/libgimpconfig/gimpconfig-serialize.c
@@ -36,6 +36,15 @@
 #include "gimpconfig-utils.h"
 
 
+/**
+ * SECTION: gimpconfig-serialize
+ * @title: GimpConfig-serialize
+ * @short_description: Serializing for libgimpconfig.
+ *
+ * Serializing interface for libgimpconfig.
+ **/
+
+
 static gboolean  gimp_config_serialize_rgb (const GValue *value,
                                             GString      *str,
                                             gboolean      has_alpha);
diff --git a/libgimpconfig/gimpconfig-utils.c b/libgimpconfig/gimpconfig-utils.c
index 6218837..270d22f 100644
--- a/libgimpconfig/gimpconfig-utils.c
+++ b/libgimpconfig/gimpconfig-utils.c
@@ -33,6 +33,15 @@
 #include "gimpconfig-utils.h"
 
 
+/**
+ * SECTION: gimpconfig-utils
+ * @title: GimpConfig-utils
+ * @short_description: Miscellaneous utility functions for libgimpconfig.
+ *
+ * Miscellaneous utility functions for libgimpconfig.
+ **/
+
+
 static gboolean
 gimp_config_diff_property (GObject    *a,
                            GObject    *b,
diff --git a/libgimpconfig/gimpconfigwriter.c b/libgimpconfig/gimpconfigwriter.c
index 9d49c1f..968fcf3 100644
--- a/libgimpconfig/gimpconfigwriter.c
+++ b/libgimpconfig/gimpconfigwriter.c
@@ -51,6 +51,16 @@
 #include "libgimp/libgimp-intl.h"
 
 
+/**
+ * SECTION: gimpconfigwriter
+ * @title: GimpConfigWriter
+ * @short_description: Functions for writing config info to a file for
+ *                     libgimpconfig.
+ *
+ * Functions for writing config info to a file for libgimpconfig.
+ **/
+
+
 struct _GimpConfigWriter
 {
   gint      fd;
diff --git a/libgimpconfig/gimpscanner.c b/libgimpconfig/gimpscanner.c
index ac7cced..9201662 100644
--- a/libgimpconfig/gimpscanner.c
+++ b/libgimpconfig/gimpscanner.c
@@ -37,6 +37,15 @@
 #include "libgimp/libgimp-intl.h"
 
 
+/**
+ * SECTION: gimpscanner
+ * @title: GimpScanner
+ * @short_description: A wrapper around #GScanner with some convenience API.
+ *
+ * A wrapper around #GScanner with some convenience API.
+ **/
+
+
 typedef struct
 {
   gchar        *name;



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