SF.net SVN: geany:[4650] branches/sm/src

[statc at users.sourceforge.net]

Revision: 4650
          http://geany.svn.sourceforge.net/geany/?rev=4650&view=rev
Author:   statc
Date:     2010-02-07 08:31:03 +0000 (Sun, 07 Feb 2010)

Log Message:
-----------
Move utils_option_entry_reverse_parse() function comments to utils.c instead of utils.h. Forbid Doxygen to generate documentation for it as it is not in plugin API.

Modified Paths:
--------------
    branches/sm/src/utils.c
    branches/sm/src/utils.h

Modified: branches/sm/src/utils.c
===================================================================
--- branches/sm/src/utils.c	2010-02-07 08:30:38 UTC (rev 4649)
+++ branches/sm/src/utils.c	2010-02-07 08:31:03 UTC (rev 4650)
@@ -1895,6 +1895,19 @@
 }
 
 
+/*
+ * "Reverse parse" @c GOptionEntry
+ *
+ * @param optentry    Object to parse.
+ * @return            Null-terminated array of strings (@c gchar*).
+ *
+ * Function takes the information about the option entry stored in @c optentry
+ * and the option's value by the address stored in @c optentry. It returns an array
+ * of strings such that it specifies the option's value when used like @c argv.
+ *
+ * Elements of the resulting array must be freed with @c g_free(). The array
+ * itself must be freed with @c g_array_free().
+ */
 GArray * utils_option_entry_reverse_parse(const GOptionEntry * optentry)
 {
 	GArray * ret = g_array_new(TRUE, TRUE, sizeof(gchar *));

Modified: branches/sm/src/utils.h
===================================================================
--- branches/sm/src/utils.h	2010-02-07 08:30:38 UTC (rev 4649)
+++ branches/sm/src/utils.h	2010-02-07 08:31:03 UTC (rev 4650)
@@ -229,20 +229,6 @@
 
 gchar *utils_str_remove_chars(gchar *string, const gchar *chars);
 
-
-/**
- * "Reverse parse" @c GOptionEntry
- *
- * @param optentry    Object to parse.
- * @return            Null-terminated array of strings (@c gchar*).
- *
- * Function takes the information about the option entry stored in @c optentry
- * and the option's value by the address stored in @c optentry. It returns an array
- * of strings such that it specifies the option's value when used like @c argv.
- *
- * Elements of the resulting array must be freed with @c g_free(). The array
- * itself must be freed with @c g_array_free().
- */
 GArray * utils_option_entry_reverse_parse(const GOptionEntry * optentry);
 
 #endif


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.