[PATCH 1/6] doc: add more documentation to grilo.c
- From: Víctor Manuel Jáquez Leal <vjaquez igalia com>
- To: grilo-list gnome org
- Subject: [PATCH 1/6] doc: add more documentation to grilo.c
- Date: Wed, 29 Sep 2010 20:43:44 +0200
Signed-off-by: Víctor Manuel Jáquez Leal <vjaquez igalia com>
---
src/grilo.c | 18 ++++++++++++++++--
1 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/src/grilo.c b/src/grilo.c
index a2f4da0..7bba467 100644
--- a/src/grilo.c
+++ b/src/grilo.c
@@ -20,6 +20,19 @@
*
*/
+/**
+ * SECTION:grl
+ * @short_description: Metadata library supporting several services
+ *
+ * Grilo is a metadata retrieval library. Given a search or browse operation,
+ * the library will retrieve a set of metadata related to the operation from a
+ * set of on-line services.
+ *
+ * The Grilo library should be initialized with grl_init() before it can be used.
+ * You should pass pointers to the main argc and argv variables so that Grilo can
+ * process its own command line options.
+ */
+
#include "grilo.h"
#include "grl-metadata-key-priv.h"
#include "grl-log-priv.h"
@@ -101,10 +114,11 @@ grl_init (gint *argc,
/**
* grl_init_get_option_group: (skip)
*
- * Returns a GOptionGroup with Grilo's argument specifications.
+ * Returns a #GOptionGroup with Grilo's argument specifications.
*
* This function is useful if you want to integrate Grilo with other
- * libraries that use #GOption (see g_option_context_add_group() ).
+ * libraries that use the GOption commandline parser
+ * (see g_option_context_add_group() ).
*
* Returns: a pointer to Grilo's option group. Should be dereferenced
* after use.
--
1.7.1
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]