[svn-commits] russell: branch russell/ast_verbose_threadstorage r39048 - /team/russell/ast_...

[svn-commits at lists.digium.com]

Author: russell
Date: Sat Aug  5 17:40:56 2006
New Revision: 39048

URL: http://svn.digium.com/view/asterisk?rev=39048&view=rev
Log:
update doxygen docs for new append functions

Modified:
    team/russell/ast_verbose_threadstorage/include/asterisk/threadstorage.h

Modified: team/russell/ast_verbose_threadstorage/include/asterisk/threadstorage.h
URL: http://svn.digium.com/view/asterisk/team/russell/ast_verbose_threadstorage/include/asterisk/threadstorage.h?rev=39048&r1=39047&r2=39048&view=diff
==============================================================================
--- team/russell/ast_verbose_threadstorage/include/asterisk/threadstorage.h (original)
+++ team/russell/ast_verbose_threadstorage/include/asterisk/threadstorage.h Sat Aug  5 17:40:56 2006
@@ -266,7 +266,14 @@
 		(__res);                                                         \
 	})
 
-#define ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap)               \
+/*!
+ * \brief Append to a thread local dynamic string using a va_list
+ *
+ * The arguments, return values, and usage of this are the same as those for
+ * ast_dynamic_str_thread_set_va().  However, instead of setting a new value
+ * for the string, this will append to the current value.
+ */
+#define ast_dynamic_str_thread_append_va(buf, max_len, ts, fmt, ap)              \
 	({                                                                       \
 		int __res;                                                       \
 		while ((__res = __ast_dynamic_str_thread_set_va(buf, max_len,    \
@@ -276,8 +283,9 @@
 		}                                                                \
 		(__res);                                                         \
 	})
-/*!
- * \brief Core functionality of ast_dynamic_str_thread_set_va
+
+/*!
+ * \brief Core functionality of ast_dynamic_str_thread_(set|append)_va
  *
  * The arguments to this function are the same as those described for
  * ast_dynamic_str_thread_set_va except for an addition argument, append.
@@ -376,6 +384,13 @@
 }
 )
 
+/*!
+ * \brief Append to a thread local dynamic string
+ *
+ * The arguments, return values, and usage of this function are the same as
+ * ast_dynamic_str_thread_set().  However, instead of setting a new value for
+ * the string, this function appends to the current value.
+ */
 AST_INLINE_API(
 int __attribute__ ((format (printf, 4, 5))) ast_dynamic_str_thread_append(
 	struct ast_dynamic_str **buf, size_t max_len, 
@@ -420,6 +435,13 @@
 }
 )
 
+/*!
+ * \brief Append to a dynatic string
+ *
+ * The arguments, return values, and usage of this function are the same as
+ * ast_dynamic_str_set().  However, this function appends to the string instead
+ * of setting a new value.
+ */
 AST_INLINE_API(
 int __attribute__ ((format (printf, 3, 4))) ast_dynamic_str_append(
 	struct ast_dynamic_str **buf, size_t max_len,