Fix a bunch of doxygen errors and document more things
authorRussell Bryant <russell@russellbryant.com>
Thu, 7 Jun 2007 23:07:25 +0000 (23:07 +0000)
committerRussell Bryant <russell@russellbryant.com>
Thu, 7 Jun 2007 23:07:25 +0000 (23:07 +0000)
(issue #9842, snuffy)

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

16 files changed:
apps/app_skel.c
channels/chan_h323.c
channels/chan_sip.c
contrib/asterisk-ng-doxygen
funcs/func_shell.c
include/asterisk/devicestate.h
include/asterisk/doxyref.h
include/asterisk/event.h
include/asterisk/http.h
include/asterisk/manager.h
include/asterisk/stringfields.h
include/asterisk/strings.h
main/devicestate.c
main/manager.c
main/rtp.c
res/res_config_sqlite.c

index 47bb2af..230e952 100644 (file)
@@ -20,7 +20,7 @@
  *
  * \brief Skeleton application
  *
- * \author\verbatim <Your Name Here> <<Your Email Here>> \endvebatim
+ * \author\verbatim <Your Name Here> <<Your Email Here>> \endverbatim
  * 
  * This is a skeleton for development of an Asterisk application 
  * \ingroup applications
index 57112d7..0c0d937 100644 (file)
@@ -1937,9 +1937,10 @@ static struct rtp_info *external_rtp_create(unsigned call_reference, const char
        return info;
 }
 
-/*! \brief
+/* 
  * Definition taken from rtp.c for rtpPayloadType because we need it here.
  */
+
 struct rtpPayloadType {
        int isAstFormat;        /* whether the following code is an AST_FORMAT */
        int code;
index 08de266..a012c45 100644 (file)
@@ -1244,8 +1244,9 @@ static void temp_pvt_cleanup(void *);
 /*! \brief A per-thread temporary pvt structure */
 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
 
-/*! \todo Move the sip_auth list to AST_LIST */
-static struct sip_auth *authl = NULL;          /*!< Authentication list for realm authentication */
+/*! \breif Authentication list for realm authentication 
+ * \todo Move the sip_auth list to AST_LIST */
+static struct sip_auth *authl = NULL;
 
 
 /* --- Sockets and networking --------------*/
@@ -2442,12 +2443,13 @@ static const char *find_closing_quote(const char *start, const char *lim)
        \return pointer to terminated stripped string
        \param tmp input string that will be modified
        Examples:
-
+\verbatim
        "foo" <bar>     valid input, returns bar
        foo             returns the whole string
        < "foo ... >    returns the string between brackets
        < "foo...       bogus (missing closing bracket), returns the whole string
                        XXX maybe should still skip the opening bracket
+\endverbatim
  */
 static char *get_in_brackets(char *tmp)
 {
@@ -2496,7 +2498,9 @@ static char *get_in_brackets(char *tmp)
  * Init pointers to empty string so we never get NULL dereferencing.
  * Overwrites the string.
  * return 0 on success, other values on error.
+ * \verbatim 
  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
+ * \endverbatim
  */
 static int parse_uri(char *uri, char *scheme,
        char **ret_name, char **pass, char **domain, char **port, char **options)
@@ -5933,7 +5937,9 @@ static int copy_all_header(struct sip_request *req, const struct sip_request *or
 \note  If the client indicates that it wishes to know the port we received from,
        it adds ;rport without an argument to the topmost via header. We need to
        add the port number (from our point of view) to that parameter.
+\verbatim
        We always add ;received=<ip address> to the topmost via header.
+\endverbatim
        Received: RFC 3261, rport RFC 3581 */
 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field)
 {
@@ -7453,7 +7459,11 @@ static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmetho
 
 /*! \brief Build REFER/INVITE/OPTIONS message and transmit it 
        \param init 0 = Prepare request within dialog, 1= prepare request, new branch, 2= prepare new request and new dialog. do_proxy_auth calls this with init!=2
-       */
+ \param p sip_pvt structure
+ \param sdp unknown 
+ \param sipmethod unknown 
+*/
 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init)
 {
        struct sip_request req;
@@ -8947,10 +8957,12 @@ static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *r
  * Terminate the uri at the first ';' or space.
  * Technically we should ignore escaped space per RFC3261 (19.1.1 etc)
  * but don't do it for the time being. Remember the uri format is:
+ *\verbatim
  *
  *     sip:user:password@host:port;uri-parameters?headers
  *     sips:user:password@host:port;uri-parameters?headers
  *
+ *\endverbatim
  */
 static char *terminate_uri(char *uri)
 {
index 6186e2c..f1259ee 100644 (file)
@@ -1,4 +1,4 @@
-# Doxyfile 1.4.2
+# Doxyfile 1.5.2
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project
 # Project related configuration options
 #---------------------------------------------------------------------------
 
+# This tag specifies the encoding used for all characters in the config file that 
+# follow. The default is UTF-8 which is also the encoding used for all text before 
+# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
+# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
+# possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
 
 PROJECT_NAME           = "Asterisk - the Open Source PBX"
 
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
+# This could be handy for archiving the generated documentation or 
+# if some version control system is used.
+
+PROJECT_NUMBER         = 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -40,24 +53,14 @@ CREATE_SUBDIRS         = NO
 # documentation generated by doxygen is written. Doxygen will use this 
 # information to generate all constant output in the proper language. 
 # The default language is English, other supported languages are: 
-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
-# Swedish, and Ukrainian.
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
+# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
+# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
+# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
+# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
 
 OUTPUT_LANGUAGE        = English
 
-# This tag can be used to specify the encoding used in the generated output. 
-# The encoding is not always determined by the language that is chosen, 
-# but also whether or not the output is meant for Windows or non-Windows users. 
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
-# forces the Windows encoding (this is the default for the Windows binary), 
-# whereas setting the tag to NO uses a Unix-style encoding (the default for 
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = NO
-
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
 # include brief member descriptions after the members that are listed in 
 # the file and class documentation (similar to JavaDoc). 
@@ -156,13 +159,6 @@ DETAILS_AT_TOP         = NO
 
 INHERIT_DOCS           = YES
 
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
-# tag is set to YES, then doxygen will reuse the documentation of the first 
-# member in the group (if any) for the other members of the group. By default 
-# all members of a group must be documented explicitly.
-
-DISTRIBUTE_GROUP_DOC   = NO
-
 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
 # a new page for each member. If set to NO, the documentation of a member will 
 # be part of the file/class/namespace that contains it.
@@ -181,7 +177,7 @@ TAB_SIZE               = 3
 # will result in a user-defined paragraph with heading "Side Effects:". 
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES += "extref=\xrefitem extref \"ExtRef\" \"External references\""
+ALIASES                = "extref=\xrefitem extref \"ExtRef\" \"External references\""
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
 # sources only. Doxygen will then generate output that is more tailored for C. 
@@ -190,13 +186,34 @@ ALIASES += "extref=\xrefitem extref \"ExtRef\" \"External references\""
 
 OPTIMIZE_OUTPUT_FOR_C  = YES
 
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
-# only. Doxygen will then generate output that is more tailored for Java. 
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
+# sources only. Doxygen will then generate output that is more tailored for Java. 
 # For instance, namespaces will be presented as packages, qualified scopes 
 # will look different, etc.
 
 OPTIMIZE_OUTPUT_JAVA   = NO
 
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
+# include (a tag file for) the STL sources as input, then you should 
+# set this tag to YES in order to let doxygen match functions declarations and 
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
+# func(std::string) {}). This also make the inheritance and collaboration 
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
+# tag is set to YES, then doxygen will reuse the documentation of the first 
+# member in the group (if any) for the other members of the group. By default 
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
 # the same type (for instance a group of public functions) to be put as a 
 # subgroup of that type (e.g. under the Public Functions section). Set it to 
@@ -371,7 +388,7 @@ SHOW_USED_FILES        = YES
 
 # If the sources in your project are distributed over multiple directories 
 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
-# in the documentation.
+# in the documentation. The default is NO.
 
 SHOW_DIRECTORIES       = YES
 
@@ -380,7 +397,7 @@ SHOW_DIRECTORIES       = YES
 # version control system). Doxygen will invoke the program by executing (via 
 # popen()) the command <command> <input-file>, where <command> is the value of 
 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
-# provided by doxygen. Whatever the progam writes to standard output 
+# provided by doxygen. Whatever the program writes to standard output 
 # is used as the file version. See the manual for examples.
 
 FILE_VERSION_FILTER    = 
@@ -446,27 +463,34 @@ WARN_LOGFILE           =
 # with spaces.
 
 INPUT                  = ./ \
-                        main \
-                        include \
+                         main \
+                         include \
                          include/asterisk \
-                        channels \
-                        channels/misdn \
-                        funcs \
-                        main/stdtime \
-                        apps \
-                        cdr \
-                        codecs \
-                        formats \
-                        pbx \
-                        agi \
-                        res
+                         channels \
+                         channels/misdn \
+                         funcs \
+                         main/stdtime \
+                         apps \
+                         cdr \
+                         codecs \
+                         formats \
+                         pbx \
+                         agi \
+                         res
+
+# This tag can be used to specify the character encoding of the source files that 
+# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
+# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
+# See http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 # and *.h) to filter out the source-files in the directories. If left 
 # blank the following patterns are tested: 
 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
 
 FILE_PATTERNS          = *.c \
                          *.h
@@ -491,17 +515,26 @@ EXCLUDE_SYMLINKS       = NO
 
 # If the value of the INPUT tag contains directories, you can use the 
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
-# certain files from those directories.
+# certain files from those directories. Note that the wildcards are matched 
+# against the file with absolute path, so to exclude all test directories 
+# for example use the pattern */test/*
 
 EXCLUDE_PATTERNS       = 
 
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
+# (namespaces, classes, functions, etc.) that should be excluded from the output. 
+# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
+# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        = 
+
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
 EXAMPLE_PATH           = ./ \
-                       doc \
-                       configs
+                         doc \
+                         configs
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -582,6 +615,21 @@ REFERENCED_BY_RELATION = YES
 
 REFERENCES_RELATION    = YES
 
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.  Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code 
+# will point to the HTML generated by the htags(1) tool instead of doxygen 
+# built-in source browser. The htags tool is part of GNU's global source 
+# tagging system (see http://www.gnu.org/software/global/global.html). You 
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
+
 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
 # will generate a verbatim copy of the header file for each class for 
 # which an include is specified. Set to NO to disable this.
@@ -968,7 +1016,7 @@ MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
 # then the macro expansion is limited to the macros specified with the 
-# PREDEFINED and EXPAND_AS_PREDEFINED tags.
+# PREDEFINED and EXPAND_AS_DEFINED tags.
 
 EXPAND_ONLY_PREDEF     = YES
 
@@ -1071,6 +1119,14 @@ PERL_PATH              = /usr/bin/perl
 
 CLASS_DIAGRAMS         = NO
 
+# You can define message sequence charts within doxygen comments using the \msc 
+# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
+# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
+# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
+# be found in the default search path.
+
+MSCGEN_PATH            = 
+
 # If set to YES, the inheritance and collaboration graphs will hide 
 # inheritance and usage relations if the target is undocumented 
 # or is not a class.
@@ -1082,8 +1138,7 @@ HIDE_UNDOC_RELATIONS   = YES
 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
 # have no effect if this option is set to NO (the default)
 
-#Created by Asterisk Makefile
-#HAVE_DOT               = NO
+HAVE_DOT               = NO
 
 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
 # will generate a graph for each documented class showing the direct and 
@@ -1137,6 +1192,14 @@ INCLUDED_BY_GRAPH      = YES
 
 CALL_GRAPH             = NO
 
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
+# generate a caller dependency graph for every global function or class method. 
+# Note that enabling this option will significantly increase the time of a run. 
+# So in most cases it will be better to enable caller graphs for selected 
+# functions only using the \callergraph command.
+
+CALLER_GRAPH           = NO
+
 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
 # will graphical hierarchy of all classes instead of a textual one.
 
@@ -1166,33 +1229,13 @@ DOT_PATH               =
 
 DOTFILE_DIRS           = 
 
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_WIDTH    = 1024
-
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT   = 1024
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
-# graphs generated by dot. A depth value of 3 means that only nodes reachable 
-# from the root by following a path via at most 3 edges will be shown. Nodes 
-# that lay further from the root node will be omitted. Note that setting this 
-# option to 1 or 2 may greatly reduce the computation time needed for large 
-# code bases. Also note that a graph may be further truncated if the graph's 
-# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
-# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
-# the graph is not depth-constrained.
-
-MAX_DOT_GRAPH_DEPTH    = 0
+# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
+# nodes that will be shown in the graph. If the number of nodes in a graph 
+# becomes larger than this value, doxygen will truncate the graph, which is 
+# visualized by representing a node as a red box. Note that doxygen will always 
+# show the root nodes and its direct children regardless of this setting.
+
+DOT_GRAPH_MAX_NODES    = 50
 
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
 # background. This is disabled by default, which results in a white background. 
index 39fc9f5..668631a 100644 (file)
@@ -16,7 +16,7 @@
 
 /*! \file
  *
- * \SHELL function to return the value of a system call.
+ * SHELL function to return the value of a system call.
  * 
  * \note Inspiration and Guidance from Russell! Thank You! 
  *
index b13547a..c6e3d43 100644 (file)
@@ -72,7 +72,7 @@ const char *devstate2str(enum ast_device_state devstate);
 const char *ast_devstate_str(enum ast_device_state devstate);
 
 /*! \brief Convert device state from text to integer value
- * \param The text representing the device state.  Valid values are anything
+ * \param val The text representing the device state.  Valid values are anything
  *        that comes after AST_DEVICE_ in one of the defined values.
  * \return The AST_DEVICE_ integer value
  */
index af949a7..1514cdf 100644 (file)
@@ -16,7 +16,7 @@
  * at the top of the source tree.
  */
 
-/*! \file This file generates Doxygen pages from files in the /doc
+/*! \file doxyref.h This file generates Doxygen pages from files in the /doc
  directory of the Asterisk source code tree 
  */
 
index 80debd4..2febeb3 100644 (file)
@@ -280,7 +280,7 @@ int ast_event_queue_and_cache(struct ast_event *event, ...);
 /*!
  * \brief Retrieve an event from the cache
  *
- * \param event_type The type of event to retrieve from the cache
+ * \param ast_event_type The type of event to retrieve from the cache
  *
  * The rest of the arguments to this function specify information elements to
  * match for retrieving events from the cache.  They are specified in the form:
index 9508188..9d92ef5 100644 (file)
@@ -141,9 +141,11 @@ int ssl_setup(struct tls_config *cfg);
    return the content, allocated with malloc().  Status should be changed to reflect
    the status of the request if it isn't 200 and title may be set to a malloc()'d string
    to an appropriate title for non-200 responses.  Content length may also be specified. 
+\verbatim   
    The return value may include additional headers at the front and MUST include a blank 
    line with \r\n to provide separation between user headers and content (even if no
    content is specified) 
+\endverbatim
 */
 typedef struct ast_str *(*ast_http_callback)(struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength);
 
index 8d1e857..1cbfb5d 100644 (file)
  Manager protocol packages are text fields of the form a: b.  There is
  always exactly one space after the colon.
 
+\verbatim
+
  The first header type is the "Event" header.  Other headers vary from
  event to event.  Headers end with standard \r\n termination.
  The last line of the manager response or event is an empty line.
  (\r\n)
 
+\endverbatim
+
  ** Please try to re-use existing headers to simplify manager message parsing in clients.
     Don't re-use an existing header with a new meaning, please.
     You can find a reference of standard headers in doc/manager.txt
index c3d6759..470a850 100644 (file)
@@ -319,7 +319,8 @@ void __ast_string_field_index_build_va(struct ast_string_field_mgr *mgr,
   \param x Pointer to a structure containing fields
   \param field Name of the field to set
   \param fmt printf-style format string
-  \param argslist a va_list of the args
+  \param args1 arguement one
+  \param args2 arguement two
   \return nothing
 */
 #define ast_string_field_build_va(x, field, fmt, args1, args2) \
index 91a3b07..ab61098 100644 (file)
@@ -47,7 +47,7 @@ static force_inline int ast_strlen_zero(const char *s)
 /*!
   \brief Gets a pointer to the first non-whitespace character in a string.
   \param ast_skip_blanks function being used
-  \param str the input string
+  \arg str the input string
   \return a pointer to the first non-whitespace character
  */
 AST_INLINE_API(
@@ -61,8 +61,8 @@ char *ast_skip_blanks(const char *str),
 
 /*!
   \brief Trims trailing whitespace characters from a string.
-  \param ast_trim_blanks function being used
-  \param str the input string
+  \param ast_skip_blanks function being used
+  \arg str the input string
   \return a pointer to the modified string
  */
 AST_INLINE_API(
@@ -88,7 +88,7 @@ char *ast_trim_blanks(char *str),
 /*!
   \brief Gets a pointer to first whitespace character in a string.
   \param ast_skip_noblanks function being used
-  \param str the input string
+  \arg str the input string
   \return a pointer to the first whitespace character
  */
 AST_INLINE_API(
@@ -102,7 +102,8 @@ char *ast_skip_nonblanks(char *str),
   
 /*!
   \brief Strip leading/trailing whitespace from a string.
-  \param s The string to be stripped (will be modified).
+  \param ast_strip function ast_strip being used.
+  \arg s The string to be stripped (will be modified).
   \return The stripped string.
 
   This functions strips all leading and trailing whitespace
@@ -147,10 +148,9 @@ char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
 
 /*!
   \brief Size-limited null-terminating string copy.
-  \param ast_copy_string function being used
-  \param dst The destination buffer.
-  \param src The source string
-  \param size The size of the destination buffer
+  \arg dst The destination buffer.
+  \arg src The source string
+  \arg size The size of the destination buffer
   \return Nothing.
 
   This is similar to \a strncpy, with two important differences:
@@ -183,9 +183,9 @@ void ast_copy_string(char *dst, const char *src, size_t size),
   This is a wrapper for snprintf, that properly handles the buffer pointer
   and buffer space available.
 
-  \param buffer current position in buffer to place string into (will be updated on return)
-  \param space remaining space in buffer (will be updated on return)
-  \param fmt printf-style format string
+  \arg buffer current position in buffer to place string into (will be updated on return)
+  \arg space remaining space in buffer (will be updated on return)
+  \arg fmt printf-style format string
   \return 0 on success, non-zero on failure.
 */
 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));
index d682602..2c30011 100644 (file)
  *     and reported back.
  *
  *     - Extension states
- *             \arg \ref enum ast_extension_states
+ *             \arg \ref ENUM ast_extension_states
  *             \arg \ref pbx.c 
  *             \arg \ref pbx.h 
  *     - Structures
- *             - \ref struct ast_state_cb  Callbacks for watchers
+ *             - \ref ast_state_cb struct.  Callbacks for watchers
  *             - Callback ast_state_cb_type
- *             - \ref struct ast_hint
+ *             - \ref ast_hint struct.
  *     - Functions
  *             - ast_extension_state_add()
  *             - ast_extension_state_del()
index 6bffad2..eb469fb 100644 (file)
@@ -2877,10 +2877,13 @@ static void xml_copy_escape(struct ast_str **out, const char *src, int mode)
  *
  * General: the unformatted text is used as a value of
  * XML output:  to be completed
+ * 
+ * \verbatim
  *   Each section is within <response type="object" id="xxx">
  *   where xxx is taken from ajaxdest variable or defaults to unknown
  *   Each row is reported as an attribute Name="value" of an XML
  *   entity named from the variable ajaxobjtype, default to "generic"
+ * \endverbatim
  *
  * HTML output:
  *   each Name-value pair is output as a single row of a two-column table.
index 617136b..e40126d 100644 (file)
@@ -774,6 +774,7 @@ static struct ast_frame *process_cisco_dtmf(struct ast_rtp *rtp, unsigned char *
  * \param data
  * \param len
  * \param seqno
+ * \param timestamp
  * \returns
  */
 static struct ast_frame *process_rfc2833(struct ast_rtp *rtp, unsigned char *data, int len, unsigned int seqno, unsigned int timestamp)
index 01bc7a4..a5bc1ef 100644 (file)
@@ -88,7 +88,7 @@
  */
 
 /*!
- * \file res_sqlite.c
+ * \file 
  * \brief res_sqlite module.
  */
 
@@ -298,6 +298,7 @@ static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames);
  * \param table                the table to use
  * \param file          the file to load from the database
  * \param cfg                  the struct ast_config object to use when storing variables
+ * \param withcomments Integer. Flag
  * \return NULL if an error occurred, cfg otherwise
  * \see add_cfg_entry()
  */