[PATCH 6/6] annotations: Annotated grilo.c



Added annotations to grl_init and grl_init_get_option_group
---
 src/grilo.c |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/src/grilo.c b/src/grilo.c
index b6ff3de..2681e34 100644
--- a/src/grilo.c
+++ b/src/grilo.c
@@ -29,6 +29,13 @@
 static gboolean grl_initialized = FALSE;
 static const gchar *plugin_path = NULL;
 
+/**
+ * grl_init:
+ * @argc: (in): number of input arguments, length of @argv
+ * @argv: (element-type utf8) (array length=argc) (allow-none): list of arguments
+ *
+ * Initializes the Grilo library
+ */
 void
 grl_init (gint *argc,
           gchar **argv[])
@@ -90,6 +97,17 @@ grl_init (gint *argc,
   grl_initialized = TRUE;
 }
 
+/**
+ * grl_init_get_option_group:
+ *
+ * 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() ).
+ *
+ * Returns: a pointer to Grilo's option group. Should be dereferenced
+ * after use.
+ */
 GOptionGroup *
 grl_init_get_option_group (void)
 {
-- 
1.7.0.4



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