[gegl] gegl-init: move documentation in header



commit 347fd97b6f9a325e411f7a8dce92e1681816e3e4
Author: Michael Murà <batolettre gmail com>
Date:   Wed Jul 18 14:52:48 2012 +0900

    gegl-init: move documentation in header

 gegl/gegl-init.c |   31 -------------------------------
 gegl/gegl-init.h |   41 ++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 40 insertions(+), 32 deletions(-)
---
diff --git a/gegl/gegl-init.c b/gegl/gegl-init.c
index 3b06719..a2aada7 100644
--- a/gegl/gegl-init.c
+++ b/gegl/gegl-init.c
@@ -154,20 +154,6 @@ static glong         global_time = 0;
 
 static const gchar *makefile (void);
 
-/**
- * gegl_init:
- * @argc: a pointer to the number of command line arguments.
- * @argv: a pointer to the array of command line arguments.
- *
- * Call this function before using any other GEGL functions. It will initialize
- * everything needed to operate GEGL and parses some standard command line
- * options.  @argc and @argv are adjusted accordingly so your own code will
- * never see those standard arguments.
- *
- * Note that there is an alternative ways to initialize GEGL: if you are
- * calling g_option_context_parse() with the option group returned by
- * gegl_get_option_group(), you don't have to call gegl_init().
- **/
 void
 gegl_init (gint    *argc,
            gchar ***argv)
@@ -248,16 +234,6 @@ static const GOptionEntry cmd_entries[]=
     { NULL }
 };
 
-/**
- * gegl_get_option_group:
- *
- * Returns a #GOptionGroup for the commandline arguments recognized
- * by GEGL. You should add this group to your #GOptionContext
- * with g_option_context_add_group(), if you are using
- * g_option_context_parse() to parse your commandline arguments.
- *
- * Returns a #GOptionGroup for the commandline arguments recognized by GEGL.
- */
 GOptionGroup *
 gegl_get_option_group (void)
 {
@@ -627,13 +603,6 @@ gegl_arg_no_debug_cb (const char *key,
 #endif
 #endif
 
-/*
- * gegl_get_debug_enabled:
- *
- * Check if gegl has debugging turned on.
- *
- * Return value: TRUE if debugging is turned on, FALSE otherwise.
- */
 gboolean
 gegl_get_debug_enabled (void)
 {
diff --git a/gegl/gegl-init.h b/gegl/gegl-init.h
index d7c95cc..51ecffc 100644
--- a/gegl/gegl-init.h
+++ b/gegl/gegl-init.h
@@ -21,12 +21,51 @@
 
 G_BEGIN_DECLS
 
-
+/**
+ * gegl_init:
+ * @argc: a pointer to the number of command line arguments.
+ * @argv: a pointer to the array of command line arguments.
+ *
+ * Call this function before using any other GEGL functions. It will initialize
+ * everything needed to operate GEGL and parses some standard command line
+ * options.  @argc and @argv are adjusted accordingly so your own code will
+ * never see those standard arguments.
+ *
+ * Note that there is an alternative ways to initialize GEGL: if you are
+ * calling g_option_context_parse() with the option group returned by
+ * gegl_get_option_group(), you don't have to call gegl_init().
+ **/
 void           gegl_init              (gint    *argc,
                                        gchar ***argv);
+
+/**
+ * gegl_get_option_group:
+ *
+ * Returns a #GOptionGroup for the commandline arguments recognized
+ * by GEGL. You should add this group to your #GOptionContext
+ * with g_option_context_add_group(), if you are using
+ * g_option_context_parse() to parse your commandline arguments.
+ *
+ * Returns a #GOptionGroup for the commandline arguments recognized by GEGL.
+ */
 GOptionGroup * gegl_get_option_group  (void);
+
+/**
+ * gegl_exit:
+ *
+ * Call this function when you're done using GEGL. It will clean up
+ * caches and write/dump debug information if the correct debug flags
+ * are set.
+ */
 void           gegl_exit              (void);
 
+/**
+ * gegl_get_debug_enabled:
+ *
+ * Check if gegl has debugging turned on.
+ *
+ * Return value: TRUE if debugging is turned on, FALSE otherwise.
+ */
 gboolean       gegl_get_debug_enabled (void); /* should be moved into config */
 
 void           gegl_get_version          (int *major,



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