[svn-commits] junky: branch junky/cli-tls r212240 - in /team/junky/cli-tls: include/asteris...

[SVN commits to the Digium repositories]

Author: junky
Date: Thu Aug 13 21:05:29 2009
New Revision: 212240

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=212240
Log:
added doxygen doc
remove an unused prototype.


Modified:
    team/junky/cli-tls/include/asterisk/pbx.h
    team/junky/cli-tls/main/logger.c

Modified: team/junky/cli-tls/include/asterisk/pbx.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/junky/cli-tls/include/asterisk/pbx.h?view=diff&rev=212240&r1=212239&r2=212240
==============================================================================
--- team/junky/cli-tls/include/asterisk/pbx.h (original)
+++ team/junky/cli-tls/include/asterisk/pbx.h Thu Aug 13 21:05:29 2009
@@ -1216,12 +1216,6 @@
  */
 char *ast_complete_applications(const char *line, const char *word, int state);
 
-
-
-/* To add a channel to a TLS object */
-int tls_add_channel(struct ast_channel *chan);
-
-
 #if defined(__cplusplus) || defined(c_plusplus)
 }
 #endif

Modified: team/junky/cli-tls/main/logger.c
URL: http://svn.asterisk.org/svn-view/asterisk/team/junky/cli-tls/main/logger.c?view=diff&rev=212240&r1=212239&r2=212240
==============================================================================
--- team/junky/cli-tls/main/logger.c (original)
+++ team/junky/cli-tls/main/logger.c Thu Aug 13 21:05:29 2009
@@ -1722,8 +1722,12 @@
 	}
 }
 
-//http://pastebin.ca/1474652
-/* Function used to add a specific channel to the TLS container */
+/*!
+ * \brief Function used to add a specific channel to the TLS container 
+ * \param[in] chan The ast_channel to add to the container
+ * \retval -1 If the channel was not added to the container.
+ * \retval 0 If the channel was successfully added to the container.
+ */
 int ast_channel_threadassoc_add(struct ast_channel *chan){
         struct logger_filter_list_item *filter;
 	channels = ast_threadstorage_get(&filter_channels, sizeof(*channels));
@@ -1742,9 +1746,14 @@
 	return 0;
 }
 
-/* Function used to remove a specific channel from the TLS container 
-Will be used for different channel driver monitor threads
-*/
+/*!
+ * \brief Function used to delete a specific channel from the TLS container 
+ * \param[in] chan The ast_channel to delete from the container
+ * \retval -1 If the channel was not deleted to the container.
+ * \retval 0 If the channel was successfully deleted from the container.
+ * This function must be called from different channel driver monitor threads
+ * after pbx_start()
+ */
 int ast_channel_threadassoc_del(struct ast_channel *chan){
 	struct logger_filter_list_item *filter;
 	int res = -1;
@@ -1769,7 +1778,10 @@
 }
 
 
-
+/*!
+ * \brief Function called from TLS API to clean 
+ * \param[in] data the ast_channels to clean, which is called by the API
+ */
 static void filter_channel_cleanup(void *data)
 {
         struct logger_filter_list_item *filter = data;
@@ -1795,6 +1807,12 @@
 	*/
 }
 
+/*!
+ * \brief Function used to make the comparison 
+ * \retval -1 If no filter are currently active.
+ * \retval 0 If a comparator matches one of the filter.
+ * \retval 1 If no comparator cant matches any filter.
+ */
 int ast_is_string_match_cli_filters(void) {
 	int res = -1;
 	struct logger_filter_list_item *filter;
@@ -1849,8 +1867,11 @@
 	return res;
 }
 
-/* Function which return a pointer to the filter for a specific name
- * Returns NULL if no filters matches
+/*!
+ * \brief Function which return a pointer to the filter for a specific name
+ * \param[in] name The filter name to retrieve
+ * \retval NULL if 'name' cannot be found in the existing list of filters. 
+ * \retval pointer to the ast_cli_filter matching 'name'
  */
 struct ast_cli_filter *ast_filter_get_by_name(const char *name) {
 	struct ast_cli_filter *filter;
@@ -1864,6 +1885,7 @@
 	return NULL;
 }
 
+//TODO remove that function before merge
 static void __attribute__((format(printf, 1,2))) my_printf(const char *fmt, ...) {
 #ifdef PRINTF_DEBUG
 	va_list ap;
@@ -1882,6 +1904,7 @@
 }
 
 
+//TODO remove that function before merge
 void junky_printf(const char *msg) {
 #ifdef PRINTF_DEBUG
 	printf("%s",msg);