Minor fixups to Doxygen comments.
authorDavid M. Lee <dlee@digium.com>
Tue, 7 May 2013 18:30:55 +0000 (18:30 +0000)
committerDavid M. Lee <dlee@digium.com>
Tue, 7 May 2013 18:30:55 +0000 (18:30 +0000)
The \example tags marks an entire file as an example, not a code snippet.
........

Merged revisions 387823 from http://svn.asterisk.org/svn/asterisk/branches/11

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387824 65c4cc65-6c06-0410-ace0-fbb531ad65f3

main/manager.c
res/res_config_pgsql.c

index 9e500e8..3994433 100644 (file)
@@ -4726,7 +4726,7 @@ static int blackfilter_cmp_fn(void *obj, void *arg, void *data, int flags)
        return 0;
 }
 
-/*
+/*!
  * \brief Manager command to add an event filter to a manager session
  * \see For more details look at manager_add_filter
  */
@@ -4760,10 +4760,9 @@ static int action_filter(struct mansession *s, const struct message *m)
        return 0;
 }
 
-/*
+/*!
  * \brief Add an event filter to a manager session
  *
- * \param s               manager session to modify filters on
  * \param filter_pattern  Filter syntax to add, see below for syntax
  *
  * \return FILTER_ALLOC_FAILED   Memory allocation failure
@@ -4774,9 +4773,12 @@ static int action_filter(struct mansession *s, const struct message *m)
  * Filter can be any valid regular expression
  * Filter can be a valid regular expression prefixed with !, which will add the filter as a black filter
  *
- * \example filter_pattern = "Event: Newchannel"
- * \example filter_pattern = "Event: New.*"
- * \example filter_pattern = "!Channel: DAHDI.*"
+ * Examples:
+ * \code
+ *   filter_pattern = "Event: Newchannel"
+ *   filter_pattern = "Event: New.*"
+ *   filter_pattern = "!Channel: DAHDI.*"
+ * \endcode
  *
  */
 static enum add_filter_result manager_add_filter(const char *filter_pattern, struct ao2_container *whitefilters, struct ao2_container *blackfilters) {
index 5af7536..e68068c 100644 (file)
@@ -198,7 +198,7 @@ static int _pgsql_exec(const char *database, const char *tablename, const char *
  *  \return -1 on query failure
  *  \return 0 on success
  *
- *  \example
+ *  \code
  *     int i, rows;
  *     PGresult *result;
  *     char *field_name, *field_type, *field_len, *field_notnull, *field_default;
@@ -213,7 +213,7 @@ static int _pgsql_exec(const char *database, const char *tablename, const char *
  *             field_notnull = PQgetvalue(result, i, 3);
  *             field_default = PQgetvalue(result, i, 4);
  *     }
- *
+ *  \endcode
  */
 static int pgsql_exec(const char *database, const char *tablename, const char *sql, PGresult **result)
 {