[asterisk-commits] jpeeler: branch jpeeler/doxygen-cleanup r181201 - in /team/jpeeler/doxygen-cl...

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Wed Mar 11 00:17:42 CDT 2009


Author: jpeeler
Date: Wed Mar 11 00:17:38 2009
New Revision: 181201

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=181201
Log:
slowly getting there...

Modified:
    team/jpeeler/doxygen-cleanup/channels/chan_sip.c
    team/jpeeler/doxygen-cleanup/include/asterisk.h
    team/jpeeler/doxygen-cleanup/include/asterisk/astobj2.h
    team/jpeeler/doxygen-cleanup/include/asterisk/callerid.h
    team/jpeeler/doxygen-cleanup/include/asterisk/cdr.h
    team/jpeeler/doxygen-cleanup/main/ast_expr2f.c
    team/jpeeler/doxygen-cleanup/main/cdr.c

Modified: team/jpeeler/doxygen-cleanup/channels/chan_sip.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/channels/chan_sip.c?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/channels/chan_sip.c (original)
+++ team/jpeeler/doxygen-cleanup/channels/chan_sip.c Wed Mar 11 00:17:38 2009
@@ -42,7 +42,7 @@
  *  from cancelling the transaction (RFC 3261 13.3.1.1). See bug #11157.
  * 
  * ******** Wishlist: Improvements
- * - Support of SIP domains for devices, so that we match on username at domain in the From: header
+ * - Support of SIP domains for devices, so that we match on username\@domain in the From: header
  * - Connect registrations with a specific device on the incoming call. It's not done
  *   automatically in Asterisk
  *
@@ -4541,9 +4541,13 @@
 /*! 
  * \brief Locate device by name or ip address 
  *
+ * \param peer
+ * \param sin
+ * \param realtime
  * \param which_objects Define which objects should be matched when doing a lookup
  *        by name.  Valid options are FINDUSERS, FINDPEERS, or FINDALLDEVICES.
  *        Note that this option is not used at all when doing a lookup by IP.
+ * \param devstate_only
  *
  *	This is used on find matching device on name or ip/port.
  * If the device was declared as type=peer, we don't match on peer name on incoming INVITEs.
@@ -8358,7 +8362,7 @@
 /*! \brief Set destination from SIP URI 
  *
  * Parse uri to h (host) and port - uri is already just the part inside the <> 
- * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
+ * general form we are expecting is sip[s]:username[:password][;parameter]\@host[:port][;...] 
  * If there's a port given, turn NAPTR/SRV off. NAPTR might indicate SIPS preference even
  * for SIP: uri's
  *

Modified: team/jpeeler/doxygen-cleanup/include/asterisk.h
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/include/asterisk.h?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/include/asterisk.h (original)
+++ team/jpeeler/doxygen-cleanup/include/asterisk.h Wed Mar 11 00:17:38 2009
@@ -146,7 +146,7 @@
  *
  * (note, this must be documented a lot more)
  * ast_add_profile allocates a generic 'counter' with a given name,
- * which can be shown with the command 'show profile <name>'
+ * which can be shown with the command 'show profile \<name\>'
  *
  * The counter accumulates positive or negative values supplied by
  * ast_add_profile(), dividing them by the 'scale' value passed in the

Modified: team/jpeeler/doxygen-cleanup/include/asterisk/astobj2.h
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/include/asterisk/astobj2.h?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/include/asterisk/astobj2.h (original)
+++ team/jpeeler/doxygen-cleanup/include/asterisk/astobj2.h Wed Mar 11 00:17:38 2009
@@ -402,9 +402,9 @@
  * - the returned pointer cannot be free()'d or realloc()'ed;
  *   rather, we just call ao2_ref(o, -1);
  */
-
+void *_ao2_alloc(const size_t data_size, ao2_destructor_fn destructor_fn);
+void *_ao2_alloc_debug(const size_t data_size, ao2_destructor_fn destructor_fn, char *tag, char *file, int line, const char *funcname);
 #ifdef REF_DEBUG
-
 
 #define ao2_t_alloc(arg1, arg2, arg3) _ao2_alloc_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
 #define ao2_alloc(arg1, arg2)         _ao2_alloc_debug((arg1), (arg2), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -415,8 +415,6 @@
 #define ao2_alloc(arg1,arg2)        _ao2_alloc((arg1), (arg2))
 
 #endif
-void *_ao2_alloc_debug(const size_t data_size, ao2_destructor_fn destructor_fn, char *tag, char *file, int line, const char *funcname);
-void *_ao2_alloc(const size_t data_size, ao2_destructor_fn destructor_fn);
 
 
 /*! \brief
@@ -439,6 +437,8 @@
  * can go away is when we release our reference, and it is
  * the last one in existence.
  */
+int _ao2_ref(void *o, int delta);
+int _ao2_ref_debug(void *o, int delta, char *tag, char *file, int line, const char *funcname);
 
 #ifdef REF_DEBUG
 #define ao2_t_ref(arg1,arg2,arg3) _ao2_ref_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -447,8 +447,6 @@
 #define ao2_t_ref(arg1,arg2,arg3) _ao2_ref((arg1), (arg2))
 #define ao2_ref(arg1,arg2)        _ao2_ref((arg1), (arg2))
 #endif
-int _ao2_ref_debug(void *o, int delta, char *tag, char *file, int line, const char *funcname);
-int _ao2_ref(void *o, int delta);
 
 /*! \brief
  * Lock an object.
@@ -688,19 +686,18 @@
  *
  * destructor is set implicitly.
  */
-
-#ifdef REF_DEBUG
-#define ao2_t_container_alloc(arg1,arg2,arg3,arg4) _ao2_container_alloc_debug((arg1), (arg2), (arg3), (arg4),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
-#define ao2_container_alloc(arg1,arg2,arg3)        _ao2_container_alloc_debug((arg1), (arg2), (arg3), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
-#else
-#define ao2_t_container_alloc(arg1,arg2,arg3,arg4) _ao2_container_alloc((arg1), (arg2), (arg3))
-#define ao2_container_alloc(arg1,arg2,arg3)        _ao2_container_alloc((arg1), (arg2), (arg3))
-#endif
 struct ao2_container *_ao2_container_alloc(const unsigned int n_buckets,
 										  ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn);
 struct ao2_container *_ao2_container_alloc_debug(const unsigned int n_buckets,
 												ao2_hash_fn *hash_fn, ao2_callback_fn *cmp_fn,
 												char *tag, char *file, int line, const char *funcname);
+#ifdef REF_DEBUG
+#define ao2_t_container_alloc(arg1,arg2,arg3,arg4) _ao2_container_alloc_debug((arg1), (arg2), (arg3), (arg4),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
+#define ao2_container_alloc(arg1,arg2,arg3)        _ao2_container_alloc_debug((arg1), (arg2), (arg3), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
+#else
+#define ao2_t_container_alloc(arg1,arg2,arg3,arg4) _ao2_container_alloc((arg1), (arg2), (arg3))
+#define ao2_container_alloc(arg1,arg2,arg3)        _ao2_container_alloc((arg1), (arg2), (arg3))
+#endif
 
 /*! \brief
  * Returns the number of elements in a container.
@@ -732,6 +729,8 @@
  * \note This function automatically increases the reference count to account
  *       for the reference that the container now holds to the object.
  */
+void *_ao2_link(struct ao2_container *c, void *newobj);
+void *_ao2_link_debug(struct ao2_container *c, void *new_obj, char *tag, char *file, int line, const char *funcname);
 #ifdef REF_DEBUG
 
 #define ao2_t_link(arg1, arg2, arg3) _ao2_link_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -740,8 +739,6 @@
 #define ao2_t_link(arg1, arg2, arg3) _ao2_link((arg1), (arg2))
 #define ao2_link(arg1, arg2)         _ao2_link((arg1), (arg2))
 #endif
-void *_ao2_link_debug(struct ao2_container *c, void *new_obj, char *tag, char *file, int line, const char *funcname);
-void *_ao2_link(struct ao2_container *c, void *newobj);
 
 /*!
  * \brief Remove an object from the container
@@ -759,6 +756,8 @@
  *       reference to the object will be automatically released. (The
  *       refcount will be decremented).
  */
+void *_ao2_unlink(struct ao2_container *c, void *obj);
+void *_ao2_unlink_debug(struct ao2_container *c, void *obj, char *tag, char *file, int line, const char *funcname);
 #ifdef REF_DEBUG
 #define ao2_t_unlink(arg1, arg2, arg3) _ao2_unlink_debug((arg1), (arg2), (arg3),  __FILE__, __LINE__, __PRETTY_FUNCTION__)
 #define ao2_unlink(arg1, arg2)         _ao2_unlink_debug((arg1), (arg2), "",  __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -766,8 +765,6 @@
 #define ao2_t_unlink(arg1, arg2, arg3) _ao2_unlink((arg1), (arg2))
 #define ao2_unlink(arg1, arg2)         _ao2_unlink((arg1), (arg2))
 #endif
-void *_ao2_unlink_debug(struct ao2_container *c, void *obj, char *tag, char *file, int line, const char *funcname);
-void *_ao2_unlink(struct ao2_container *c, void *obj);
 
 
 /*! \brief Used as return value if the flag OBJ_MULTIPLE is set */
@@ -854,6 +851,12 @@
  * \note When the returned object is no longer in use, ao2_ref() should
  * be used to free the additional reference possibly created by this function.
  */
+void *_ao2_callback(struct ao2_container *c,
+					enum search_flags flags,
+					ao2_callback_fn *cb_fn, void *arg);
+void *_ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
+						  ao2_callback_fn *cb_fn, void *arg, char *tag,
+						  char *file, int line, const char *funcname);
 #ifdef REF_DEBUG
 #define ao2_t_callback(arg1,arg2,arg3,arg4,arg5) _ao2_callback_debug((arg1), (arg2), (arg3), (arg4), (arg5), __FILE__, __LINE__, __PRETTY_FUNCTION__)
 #define ao2_callback(arg1,arg2,arg3,arg4)        _ao2_callback_debug((arg1), (arg2), (arg3), (arg4), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -861,12 +864,6 @@
 #define ao2_t_callback(arg1,arg2,arg3,arg4,arg5) _ao2_callback((arg1), (arg2), (arg3), (arg4))
 #define ao2_callback(arg1,arg2,arg3,arg4)        _ao2_callback((arg1), (arg2), (arg3), (arg4))
 #endif
-void *_ao2_callback_debug(struct ao2_container *c, enum search_flags flags,
-						  ao2_callback_fn *cb_fn, void *arg, char *tag,
-						  char *file, int line, const char *funcname);
-void *_ao2_callback(struct ao2_container *c,
-					enum search_flags flags,
-					ao2_callback_fn *cb_fn, void *arg);
 
 /*! \brief
  * ao2_callback_data() is a generic function that applies cb_fn() to all objects

Modified: team/jpeeler/doxygen-cleanup/include/asterisk/callerid.h
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/include/asterisk/callerid.h?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/include/asterisk/callerid.h (original)
+++ team/jpeeler/doxygen-cleanup/include/asterisk/callerid.h Wed Mar 11 00:17:38 2009
@@ -170,9 +170,14 @@
 int ast_callerid_generate(unsigned char *buf, const char *name, const char *number, int codec);
 
 /*! \brief Generate message waiting indicator
+ *  \param buf
  *  \param active The message indicator state
  *  -- either 0 no messages in mailbox or 1 messages in mailbox
  *  \param type Format of message (any of CID_MWI_TYPE_*)
+ *  \param codec
+ *  \param name
+ *  \param number
+ *  \param flags
  *  \see callerid_generate() for more info as it use the same encoding
  *  \version 1.6.1 changed mdmf parameter to type, added name, number and flags for caller id message generation
 */

Modified: team/jpeeler/doxygen-cleanup/include/asterisk/cdr.h
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/include/asterisk/cdr.h?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/include/asterisk/cdr.h (original)
+++ team/jpeeler/doxygen-cleanup/include/asterisk/cdr.h Wed Mar 11 00:17:38 2009
@@ -319,7 +319,7 @@
 /*! Flags to a string */
 /*!
  * \param flags binary flag
- * Converts binary flags to string flags
+ * Converts AMA flags to printable string flags
  * Returns string with flag name
  */
 char *ast_cdr_flags2str(int flags);

Modified: team/jpeeler/doxygen-cleanup/main/ast_expr2f.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/main/ast_expr2f.c?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/main/ast_expr2f.c (original)
+++ team/jpeeler/doxygen-cleanup/main/ast_expr2f.c Wed Mar 11 00:17:38 2009
@@ -1962,8 +1962,8 @@
 
 /** Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will
  * scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
+ * @param yybytes the byte buffer to scan
+ * @param _yybytes_len the number of bytes in the buffer pointed to by @a bytes.
  * @param yyscanner The scanner object.
  * @return the newly allocated buffer state object.
  */
@@ -2124,7 +2124,7 @@
 }
 
 /** Set the current column.
- * @param line_number
+ * @param column_no
  * @param yyscanner The scanner object.
  */
 void ast_yyset_column (int  column_no , yyscan_t yyscanner)

Modified: team/jpeeler/doxygen-cleanup/main/cdr.c
URL: http://svn.digium.com/svn-view/asterisk/team/jpeeler/doxygen-cleanup/main/cdr.c?view=diff&rev=181201&r1=181200&r2=181201
==============================================================================
--- team/jpeeler/doxygen-cleanup/main/cdr.c (original)
+++ team/jpeeler/doxygen-cleanup/main/cdr.c Wed Mar 11 00:17:38 2009
@@ -894,7 +894,6 @@
 	return "UNKNOWN";
 }
 
-/*! Converts AMA flag to printable string */
 char *ast_cdr_flags2str(int flag)
 {
 	switch (flag) {




More information about the asterisk-commits mailing list