SF.net SVN: geany:[4008] trunk
eht16 at users.sourceforge.net
eht16 at xxxxx
Tue Jul 21 22:09:47 UTC 2009
Revision: 4008
http://geany.svn.sourceforge.net/geany/?rev=4008&view=rev
Author: eht16
Date: 2009-07-21 22:09:43 +0000 (Tue, 21 Jul 2009)
Log Message:
-----------
Start unifying usage of @a and @c markup elements in API docs, to be continued.
Modified Paths:
--------------
trunk/ChangeLog
trunk/src/utils.c
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2009-07-21 16:23:05 UTC (rev 4007)
+++ trunk/ChangeLog 2009-07-21 22:09:43 UTC (rev 4008)
@@ -1,3 +1,10 @@
+2009-07-21 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
+
+ * src/utils.c:
+ Start unifying usage of @a and @c markup elements in API docs,
+ to be continued.
+
+
2009-07-21 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
* src/document.c:
Modified: trunk/src/utils.c
===================================================================
--- trunk/src/utils.c 2009-07-21 16:23:05 UTC (rev 4007)
+++ trunk/src/utils.c 2009-07-21 22:09:43 UTC (rev 4008)
@@ -63,7 +63,7 @@
* Tries to open the given URI in a browser.
* On Windows, the system's default browser is opened.
* On non-Windows systems, the browser command set in the preferences dialog is used. In case
- * that fails or it is unset, @a xdg-open is used as fallback as well as some other known
+ * that fails or it is unset, @c xdg-open is used as fallback as well as some other known
* browsers.
*
* @param uri The URI to open in the web browser.
@@ -214,7 +214,7 @@
/**
- * Write the given @c text into a file with @c filename.
+ * Write the given @a text into a file with @a filename.
* If the file doesn't exist, it will be created.
* If it already exists, it will be overwritten.
*
@@ -381,8 +381,8 @@
*
* The input strings should be in UTF-8 or locale encoding.
*
- * @param s1 Pointer to first string or @a NULL.
- * @param s2 Pointer to second string or @a NULL.
+ * @param s1 Pointer to first string or @c NULL.
+ * @param s2 Pointer to second string or @c NULL.
*
* @return an integer less than, equal to, or greater than zero if @a s1 is found, respectively,
* to be less than, to match, or to be greater than @a s2.
@@ -438,7 +438,7 @@
* @param string Input string.
* @param truncate_length The length in characters of the resulting string.
*
- * @return A copy of @c string which is truncated to @c truncate_length characters,
+ * @return A copy of @a string which is truncated to @a truncate_length characters,
* should be freed when no longer needed.
*
* @since 0.17
@@ -485,13 +485,13 @@
/**
- * @a NULL-safe string comparison. Returns @a TRUE if both @c a and @c b are @a NULL
- * or if @c a and @c b refer to valid strings which are equal.
+ * @c NULL-safe string comparison. Returns @c TRUE if both @a a and @a b are @c NULL
+ * or if @a a and @a b refer to valid strings which are equal.
*
- * @param a Pointer to first string or @a NULL.
- * @param b Pointer to second string or @a NULL.
+ * @param a Pointer to first string or @c NULL.
+ * @param b Pointer to second string or @c NULL.
*
- * @return @a TRUE if @c a equals @c b, else @a FALSE.
+ * @return @c TRUE if @a a equals @a b, else @c FALSE.
**/
gboolean utils_str_equal(const gchar *a, const gchar *b)
{
@@ -508,7 +508,7 @@
/**
- * Remove the extension from @c filename and return the result in a newly allocated string.
+ * Remove the extension from @a filename and return the result in a newly allocated string.
*
* @param filename The filename to operate on.
*
@@ -734,10 +734,10 @@
* @param config A GKeyFile object.
* @param section The group name to look in for the key.
* @param key The key to find.
- * @param default_value The default value which will be returned when @c section or @c key
+ * @param default_value The default value which will be returned when @a section or @a key
* don't exist.
*
- * @return The value associated with @c key as an integer, or the given default value if the value
+ * @return The value associated with @a key as an integer, or the given default value if the value
* could not be retrieved.
**/
gint utils_get_setting_integer(GKeyFile *config, const gchar *section, const gchar *key,
@@ -768,7 +768,7 @@
* @param default_value The default value which will be returned when @c section or @c key
* don't exist.
*
- * @return The value associated with @c key as a boolean, or the given default value if the value
+ * @return The value associated with @a key as a boolean, or the given default value if the value
* could not be retrieved.
**/
gboolean utils_get_setting_boolean(GKeyFile *config, const gchar *section, const gchar *key,
@@ -796,10 +796,10 @@
* @param config A GKeyFile object.
* @param section The group name to look in for the key.
* @param key The key to find.
- * @param default_value The default value which will be returned when @c section or @c key
+ * @param default_value The default value which will be returned when @a section or @a key
* don't exist.
*
- * @return A newly allocated string, either the value for @c key or a copy of the given
+ * @return A newly allocated string, either the value for @a key or a copy of the given
* default value if it could not be retrieved.
**/
gchar *utils_get_setting_string(GKeyFile *config, const gchar *section, const gchar *key,
@@ -1347,11 +1347,11 @@
* in the list should be freed after use.
*
* @param path The path of the directory to scan, in locale encoding.
- * @param length The location to store the number of non- at a NULL data items in the list,
- * unless @a NULL.
- * @param error The is the location for storing a possible error, or @a NULL.
+ * @param length The location to store the number of non- at c NULL data items in the list,
+ * unless @c NULL.
+ * @param error The is the location for storing a possible error, or @c NULL.
*
- * @return A newly allocated list or @a NULL if no files found. The list and its data should be
+ * @return A newly allocated list or @c NULL if no files found. The list and its data should be
* freed when no longer needed.
**/
GSList *utils_get_file_list(const gchar *path, guint *length, GError **error)
@@ -1445,15 +1445,15 @@
/**
- * Replaces all occurrences of @c needle in @c haystack with @c replace.
+ * Replaces all occurrences of @a needle in @a haystack with @a replace.
* As of Geany 0.16, @a replace can match @a needle, so the following will work:
* @code utils_string_replace_all(text, "\n", "\r\n"); @endcode
*
* @param haystack The input string to operate on. This string is modified in place.
* @param needle The string which should be replaced.
- * @param replace The replacement for @c needle.
+ * @param replace The replacement for @a needle.
*
- * @return @a amount of replacements done
+ * @return amount of replacements done
**/
guint utils_string_replace_all(GString *haystack, const gchar *needle, const gchar *replace)
{
@@ -1462,15 +1462,15 @@
/**
- * Convenience function to replace only the first occurrence of @c needle in @c haystack
- * with @ replace.
+ * Convenience function to replace only the first occurrence of @a needle in @a haystack
+ * with @a replace.
* For details, see utils_string_replace_all().
*
* @param haystack The input string to operate on. This string is modified in place.
* @param needle The string which should be replaced.
- * @param replace The replacement for @c needle.
+ * @param replace The replacement for @a needle.
*
- * @return @a amount of replacements done
+ * @return amount of replacements done
*
* @since 0.16
*/
@@ -1528,7 +1528,7 @@
* @param exit_status The child exit status, as returned by waitpid().
* @param error The return location for error or @a NULL.
*
- * @return @a TRUE on success, @a FALSE if an error was set.
+ * @return @c TRUE on success, @c FALSE if an error was set.
**/
gboolean utils_spawn_sync(const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
GSpawnChildSetupFunc child_setup, gpointer user_data, gchar **std_out,
@@ -1574,7 +1574,7 @@
* @param child_pid The return location for child process ID, or NULL.
* @param error The return location for error or @a NULL.
*
- * @return @a TRUE on success, @a FALSE if an error was set.
+ * @return @c TRUE on success, @c FALSE if an error was set.
**/
gboolean utils_spawn_async(const gchar *dir, gchar **argv, gchar **env, GSpawnFlags flags,
GSpawnChildSetupFunc child_setup, gpointer user_data, GPid *child_pid,
@@ -1770,10 +1770,10 @@
/**
* Remove characters from a string.
*
- * @param str The original string
+ * @param string The original string
* @param chars Characters to remove.
*
- * @return A newly-allocated copy of @c str without the characters in @c chars,
+ * @return A newly-allocated copy of @a str without the characters in @a chars,
* should be freed when no longer needed.
**/
gchar *utils_str_remove_chars(const gchar *string, const gchar *chars)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Commits
mailing list