[svn-commits] mjordan: trunk r371989 - in /trunk: ./ apps/confbridge/include/ channels/ cha...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Thu Aug 30 09:23:39 CDT 2012
Author: mjordan
Date: Thu Aug 30 09:23:28 2012
New Revision: 371989
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=371989
Log:
Clean up doxygen warnings
This patch fixes numerous doxygen warnings across Asterisk. It also updates
the makefile to regenerate the doxygen configuration on the local system
before running doxygen to help prevent warnings/errors on the local system.
Much thanks to Andrew for tackling one of the Asterisk janitor projects!
(issue ASTERISK-20259)
Reported by: Andrew Latham
Patches:
doxygen_partial.diff uploaded by Andrew Latham (license 5985)
make_progdocs.diff uploaded by Andrew Latham (license 5985)
Modified:
trunk/Makefile
trunk/apps/confbridge/include/confbridge.h
trunk/channels/chan_agent.c
trunk/channels/chan_sip.c
trunk/channels/sig_pri.h
trunk/channels/sip/include/srtp.h
trunk/channels/sip/srtp.c
trunk/codecs/speex/speex_resampler.h
trunk/formats/format_ogg_vorbis.c
trunk/include/asterisk/astobj2.h
trunk/include/asterisk/audiohook.h
trunk/include/asterisk/bridging.h
trunk/include/asterisk/bridging_technology.h
trunk/include/asterisk/ccss.h
trunk/include/asterisk/channel.h
trunk/include/asterisk/config.h
trunk/include/asterisk/config_options.h
trunk/include/asterisk/crypto.h
trunk/include/asterisk/datastore.h
trunk/include/asterisk/format.h
trunk/include/asterisk/format_cap.h
trunk/include/asterisk/format_pref.h
trunk/include/asterisk/framehook.h
trunk/include/asterisk/heap.h
trunk/include/asterisk/manager.h
trunk/include/asterisk/message.h
trunk/include/asterisk/netsock2.h
trunk/include/asterisk/pbx.h
trunk/include/asterisk/presencestate.h
trunk/include/asterisk/rtp_engine.h
trunk/include/asterisk/strings.h
trunk/include/asterisk/translate.h
trunk/include/asterisk/utils.h
trunk/main/audiohook.c
trunk/main/cdr.c
trunk/main/channel.c
trunk/main/file.c
trunk/main/named_acl.c
trunk/main/pbx.c
trunk/pbx/pbx_lua.c
Modified: trunk/Makefile
URL: http://svnview.digium.com/svn/asterisk/trunk/Makefile?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Thu Aug 30 09:23:28 2012
@@ -742,6 +742,7 @@
@echo " +-------------------------------------------+"
progdocs:
+ doxygen -u contrib/asterisk-ng-doxygen
(cat contrib/asterisk-ng-doxygen; echo "HAVE_DOT=$(HAVEDOT)"; \
echo "PROJECT_NUMBER=$(ASTERISKVERSION)") | doxygen -
Modified: trunk/apps/confbridge/include/confbridge.h
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/confbridge/include/confbridge.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/apps/confbridge/include/confbridge.h (original)
+++ trunk/apps/confbridge/include/confbridge.h Thu Aug 30 09:23:28 2012
@@ -302,10 +302,10 @@
* \brief Once a DTMF sequence matches a sequence in the user's DTMF menu, this function will get
* called to perform the menu action.
*
- * \param bridge_channel, Bridged channel this is involving
- * \param conference_bridge_user, the conference user to perform the action on.
- * \param menu_entry, the menu entry that invoked this callback to occur.
- * \param menu, an AO2 referenced pointer to the entire menu structure the menu_entry
+ * \param bridge_channel Bridged channel this is involving
+ * \param conference_bridge_user the conference user to perform the action on.
+ * \param menu_entry the menu entry that invoked this callback to occur.
+ * \param menu an AO2 referenced pointer to the entire menu structure the menu_entry
* derived from.
*
* \note The menu_entry is a deep copy of the entry found in the menu structure. This allows
Modified: trunk/channels/chan_agent.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_agent.c?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/channels/chan_agent.c (original)
+++ trunk/channels/chan_agent.c Thu Aug 30 09:23:28 2012
@@ -382,7 +382,7 @@
* unrefed once it is no longer needed.
*
* \param pvt Pointer to the LOCKED agent_pvt for which the owner is needed
- * \ret locked channel which owns the pvt at the time of completion. NULL if not available.
+ * \ref locked channel which owns the pvt at the time of completion. NULL if not available.
*/
static struct ast_channel *agent_lock_owner(struct agent_pvt *pvt)
{
Modified: trunk/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_sip.c?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Thu Aug 30 09:23:28 2012
@@ -5367,7 +5367,7 @@
/*!
* \brief Locate device by name or ip address
- * \param peer, sin, realtime, devstate_only, transport
+ * \param peer, addr, realtime, devstate_only, transport
* \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.
@@ -10965,7 +10965,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 \verbatim sip[s]:username[:password][;parameter]@host[:port][;...] \endverbatim
* If there's a port given, turn NAPTR/SRV off. NAPTR might indicate SIPS preference even
* for SIP: uri's
*
@@ -15430,8 +15430,14 @@
}
}
-/*! \brief Build route list from Record-Route header
- \param resp the SIP response code or 0 for a request */
+/*! \brief Build route list from Record-Route header
+ *
+ * \param p
+ * \param req
+ * \param backwards
+ * \param resp the SIP response code or 0 for a request
+ *
+ */
static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards, int resp)
{
struct sip_route *thishop, *head, *tail;
@@ -28415,7 +28421,7 @@
/*!
* \brief Get the session-timer mode
* \param p pointer to the SIP dialog
- * \param no_cached, set this to true in order to force a peername lookup on
+ * \param no_cached Set this to true in order to force a peername lookup on
* the session timer mode.
*/
enum st_mode st_get_mode(struct sip_pvt *p, int no_cached)
@@ -32260,7 +32266,7 @@
/*! \brief Return the first entry from ast_sockaddr_resolve filtered by address family
*
- * \warn Using this function probably means you have a faulty design.
+ * \warning Using this function probably means you have a faulty design.
*/
static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
const char* name, int flag, int family)
@@ -32284,7 +32290,7 @@
/*! \brief Return the first entry from ast_sockaddr_resolve filtered by family of binddaddr
*
- * \warn Using this function probably means you have a faulty design.
+ * \warning Using this function probably means you have a faulty design.
*/
static int ast_sockaddr_resolve_first(struct ast_sockaddr *addr,
const char* name, int flag)
@@ -32294,7 +32300,7 @@
/*! \brief Return the first entry from ast_sockaddr_resolve filtered by family of binddaddr
*
- * \warn Using this function probably means you have a faulty design.
+ * \warning Using this function probably means you have a faulty design.
*/
static int ast_sockaddr_resolve_first_transport(struct ast_sockaddr *addr,
const char* name, int flag, unsigned int transport)
Modified: trunk/channels/sig_pri.h
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sig_pri.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/channels/sig_pri.h (original)
+++ trunk/channels/sig_pri.h Thu Aug 30 09:23:28 2012
@@ -592,7 +592,7 @@
* AST_DEVICE_BUSY - All B channels are in use.
* AST_DEVICE_UNAVAILABLE - Span is in alarm.
* \note
- * Device name: \startverbatim DAHDI/I<span>/congestion. \endverbatim
+ * Device name: \verbatim DAHDI/I<span>/congestion. \endverbatim
*/
int congestion_devstate;
#if defined(THRESHOLD_DEVSTATE_PLACEHOLDER)
Modified: trunk/channels/sip/include/srtp.h
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/include/srtp.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/channels/sip/include/srtp.h (original)
+++ trunk/channels/sip/include/srtp.h Thu Aug 30 09:23:28 2012
@@ -16,7 +16,7 @@
* at the top of the source tree.
*/
-/*! \file sip_srtp.h
+/*! \file srtp.h
*
* \brief SIP Secure RTP (SRTP)
*
Modified: trunk/channels/sip/srtp.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/srtp.c?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/channels/sip/srtp.c (original)
+++ trunk/channels/sip/srtp.c Thu Aug 30 09:23:28 2012
@@ -16,7 +16,7 @@
* at the top of the source tree.
*/
-/*! \file sip_srtp.c
+/*! \file srtp.c
*
* \brief SIP Secure RTP (SRTP)
*
Modified: trunk/codecs/speex/speex_resampler.h
URL: http://svnview.digium.com/svn/asterisk/trunk/codecs/speex/speex_resampler.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/codecs/speex/speex_resampler.h (original)
+++ trunk/codecs/speex/speex_resampler.h Thu Aug 30 09:23:28 2012
@@ -137,7 +137,8 @@
* @param in_rate Input sampling rate rounded to the nearest integer (in Hz).
* @param out_rate Output sampling rate rounded to the nearest integer (in Hz).
* @param quality Resampling quality between 0 and 10, where 0 has poor quality
- * and 10 has very high quality.
+ * and 10 has very high quality.
+ * @param err
* @return Newly created resampler state
* @retval NULL Error: not enough memory
*/
Modified: trunk/formats/format_ogg_vorbis.c
URL: http://svnview.digium.com/svn/asterisk/trunk/formats/format_ogg_vorbis.c?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/formats/format_ogg_vorbis.c (original)
+++ trunk/formats/format_ogg_vorbis.c Thu Aug 30 09:23:28 2012
@@ -342,7 +342,7 @@
/*!
* \brief Trucate an OGG/Vorbis filestream.
- * \param s The filestream to truncate.
+ * \param fs The filestream to truncate.
* \return 0 on success, -1 on failure.
*/
@@ -354,7 +354,7 @@
/*!
* \brief Tell the current position in OGG/Vorbis filestream measured in pcms.
- * \param s The filestream to take action on.
+ * \param fs The filestream to take action on.
* \return 0 or greater with the position measured in samples, or -1 for false.
*/
static off_t ogg_vorbis_tell(struct ast_filestream *fs)
@@ -374,7 +374,7 @@
/*!
* \brief Seek to a specific position in an OGG/Vorbis filestream.
- * \param s The filestream to take action on.
+ * \param fs The filestream to take action on.
* \param sample_offset New position for the filestream, measured in 8KHz samples.
* \param whence Location to measure
* \return 0 on success, -1 on failure.
Modified: trunk/include/asterisk/astobj2.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/astobj2.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/astobj2.h (original)
+++ trunk/include/asterisk/astobj2.h Thu Aug 30 09:23:28 2012
@@ -522,6 +522,7 @@
* Lock an object.
*
* \param a A pointer to the object we want to lock.
+ * \param lock_how, file, func, line, var
* \return 0 on success, other values on error.
*/
int __ao2_lock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
@@ -533,6 +534,7 @@
* Unlock an object.
*
* \param a A pointer to the object we want unlock.
+ * \param file, func, line, var
* \return 0 on success, other values on error.
*/
int __ao2_unlock(void *a, const char *file, const char *func, int line, const char *var);
@@ -542,6 +544,7 @@
* Try locking-- (don't block if fail)
*
* \param a A pointer to the object we want to lock.
+ * \param lock_how, file, func, line, var
* \return 0 on success, other values on error.
*/
int __ao2_trylock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var);
@@ -1044,6 +1047,28 @@
*
* \param container The container to operate on.
* \param obj The object to be added.
+ * \param tag used for debugging.
+ *
+ * \retval NULL on errors.
+ * \retval !NULL on success.
+ *
+ * This function inserts an object in a container according its key.
+ *
+ * \note Remember to set the key before calling this function.
+ *
+ * \note This function automatically increases the reference count to account
+ * for the reference that the container now holds to the object.
+ */
+#ifdef REF_DEBUG
+
+#define ao2_t_link(container, obj, tag) __ao2_link_debug((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
+#define ao2_link(container, obj) __ao2_link_debug((container), (obj), 0, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
+
+/*!
+ * \brief Add an object to a container.
+ *
+ * \param container The container to operate on.
+ * \param obj The object to be added.
* \param flags search_flags to control linking the object. (OBJ_NOLOCK)
* \param tag used for debugging.
*
@@ -1057,11 +1082,6 @@
* \note This function automatically increases the reference count to account
* for the reference that the container now holds to the object.
*/
-#ifdef REF_DEBUG
-
-#define ao2_t_link(container, obj, tag) __ao2_link_debug((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
-#define ao2_link(container, obj) __ao2_link_debug((container), (obj), 0, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
-
#define ao2_t_link_flags(container, obj, flags, tag) __ao2_link_debug((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
#define ao2_link_flags(container, obj, flags) __ao2_link_debug((container), (obj), (flags), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
@@ -1077,6 +1097,28 @@
void *__ao2_link_debug(struct ao2_container *c, void *obj_new, int flags, const char *tag, const char *file, int line, const char *func);
void *__ao2_link(struct ao2_container *c, void *obj_new, int flags);
+
+/*!
+ * \brief Remove an object from a container
+ *
+ * \param container The container to operate on.
+ * \param obj The object to unlink.
+ * \param tag used for debugging.
+ *
+ * \retval NULL, always
+ *
+ * \note The object requested to be unlinked must be valid. However, if it turns
+ * out that it is not in the container, this function is still safe to
+ * be called.
+ *
+ * \note If the object gets unlinked from the container, the container's
+ * reference to the object will be automatically released. (The
+ * refcount will be decremented).
+ */
+#ifdef REF_DEBUG
+
+#define ao2_t_unlink(container, obj, tag) __ao2_unlink_debug((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
+#define ao2_unlink(container, obj) __ao2_unlink_debug((container), (obj), 0, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
/*!
* \brief Remove an object from a container
@@ -1096,10 +1138,6 @@
* reference to the object will be automatically released. (The
* refcount will be decremented).
*/
-#ifdef REF_DEBUG
-
-#define ao2_t_unlink(container, obj, tag) __ao2_unlink_debug((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
-#define ao2_unlink(container, obj) __ao2_unlink_debug((container), (obj), 0, "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
#define ao2_t_unlink_flags(container, obj, flags, tag) __ao2_unlink_debug((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
#define ao2_unlink_flags(container, obj, flags) __ao2_unlink_debug((container), (obj), (flags), "", __FILE__, __LINE__, __PRETTY_FUNCTION__)
Modified: trunk/include/asterisk/audiohook.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/audiohook.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/audiohook.h (original)
+++ trunk/include/asterisk/audiohook.h Thu Aug 30 09:23:28 2012
@@ -154,10 +154,10 @@
/*! \brief Reads a frame in from the audiohook structure in mixed audio mode and copies read and write frame data to provided arguments.
* \param audiohook Audiohook structure
* \param samples Number of samples wanted
- * \param direction Direction the audio frame came from
- * \param format Format of frame remote side wants back
- * \param ast_frame read_frame - if available, we'll copy the read buffer to this.
- * \param ast_frame write_frame - if available, we'll copy the write buffer to this.
+ * \param ast_format Format of frame remote side wants back
+ * \param read_frame if available, we'll copy the read buffer to this.
+ * \param write_frame if available, we'll copy the write buffer to this.
+ * \param direction
* \return Returns frame on success, NULL on failure
*/
struct ast_frame *ast_audiohook_read_frame_all(struct ast_audiohook *audiohook, size_t samples, struct ast_format *format, struct ast_frame **read_frame, struct ast_frame **write_frame);
Modified: trunk/include/asterisk/bridging.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/bridging.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/bridging.h (original)
+++ trunk/include/asterisk/bridging.h Thu Aug 30 09:23:28 2012
@@ -312,7 +312,7 @@
* \param chan Channel to join
* \param swap Channel to swap out if swapping
* \param features Bridge features structure
- * \param (Optional) Bridging tech optimization parameters for this channel.
+ * \param tech_args Optional Bridging tech optimization parameters for this channel.
*
* \retval state that channel exited the bridge with
*
@@ -504,8 +504,8 @@
/*! \brief Adjust the internal mixing sample rate of a bridge used during
* multimix mode.
*
- * \param bridge_channel Channel to change the sample rate on.
- * \param sample rate, the sample rate to change to. If a
+ * \param bridge Channel to change the sample rate on.
+ * \param sample_rate the sample rate to change to. If a
* value of 0 is passed here, the bridge will be free to pick
* what ever sample rate it chooses.
*
@@ -515,8 +515,8 @@
/*! \brief Adjust the internal mixing interval of a bridge used during
* multimix mode.
*
- * \param bridge_channel Channel to change the sample rate on.
- * \param mixing_interval, the sample rate to change to. If 0 is set
+ * \param bridge Channel to change the sample rate on.
+ * \param mixing_interval the sample rate to change to. If 0 is set
* the bridge tech is free to choose any mixing interval it uses by default.
*/
void ast_bridge_set_mixing_interval(struct ast_bridge *bridge, unsigned int mixing_interval);
Modified: trunk/include/asterisk/bridging_technology.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/bridging_technology.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/bridging_technology.h (original)
+++ trunk/include/asterisk/bridging_technology.h Thu Aug 30 09:23:28 2012
@@ -153,7 +153,7 @@
*
* \param bridge The bridge that the channel is a part of.
* \param bridge_channel The bridge channel that has either started or stopped talking.
- * \param started_talking, set to 1 when this indicates the channel has started talking, set to 0
+ * \param started_talking set to 1 when this indicates the channel has started talking set to 0
* when this indicates the channel has stopped talking.
*/
void ast_bridge_notify_talking(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, int started_talking);
Modified: trunk/include/asterisk/ccss.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/ccss.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/ccss.h (original)
+++ trunk/include/asterisk/ccss.h Thu Aug 30 09:23:28 2012
@@ -1365,8 +1365,8 @@
* The code in the core will take care of making sure that the information gets passed
* up the ladder correctly.
*
- * \param core_id The core ID of the corresponding CC transaction
- * \param debug
+ * \par core_id The core ID of the corresponding CC transaction
+ * \par debug
* \retval 0 Request successfully queued
* \retval -1 Request could not be queued
*/
@@ -1482,7 +1482,7 @@
/*!
* \since 1.8
* \brief Set the CC_INTERFACES channel variable for a channel using an
- * extension at context as a starting point
+ * \verbatim extension at context \endverbatim as a starting point
*
* \details
* The CC_INTERFACES channel variable will have the interfaces that should be
@@ -1498,7 +1498,7 @@
*
* \param chan The channel to set the CC_INTERFACES variable on
* \param extension The name of the extension for which we're setting the variable.
- * This should be in the form of "exten at context"
+ * This should be in the form of \verbatim exten at context \endverbatim
*/
int ast_set_cc_interfaces_chanvar(struct ast_channel *chan, const char * const extension);
Modified: trunk/include/asterisk/channel.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/channel.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/channel.h (original)
+++ trunk/include/asterisk/channel.h Thu Aug 30 09:23:28 2012
@@ -1280,7 +1280,7 @@
* by the low level module and attempt to place a call on it
*
* \param type type of channel to request
- * \param format capabilities for requested channel
+ * \param cap format capabilities for requested channel
* \param requestor channel asking for data
* \param addr destination of the call
* \param timeout maximum amount of time to wait for an answer
@@ -1298,7 +1298,7 @@
* \brief Request a channel of a given type, with data as optional information used
* by the low level module and attempt to place a call on it
* \param type type of channel to request
- * \param format capabilities for requested channel
+ * \param cap format capabilities for requested channel
* \param requestor channel requesting data
* \param addr destination of the call
* \param timeout maximum amount of time to wait for an answer
@@ -1317,7 +1317,7 @@
* \param caller in channel that requested orig
* \param orig channel being replaced by the call forward channel
* \param timeout maximum amount of time to wait for setup of new forward channel
- * \param format capabilities for requested channel
+ * \param cap format capabilities for requested channel
* \param oh outgoing helper used with original channel
* \param outstate reason why unsuccessful (if uncuccessful)
* \return Returns the forwarded call's ast_channel on success or NULL on failure
@@ -1794,7 +1794,7 @@
/*!
* \brief Sets read format on channel chan
* \param chan channel to change
- * \param formats, format to set for reading
+ * \param format format to set for reading
* \return Returns 0 on success, -1 on failure
*/
int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
@@ -1802,7 +1802,7 @@
/*!
* \brief Sets read format on channel chan by id
* \param chan channel to change
- * \param format id to set for reading, only used for formats without attributes
+ * \param id format id to set for reading, only used for formats without attributes
* \return Returns 0 on success, -1 on failure
*/
int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
@@ -1819,7 +1819,7 @@
/*!
* \brief Sets write format on channel chan
* \param chan channel to change
- * \param formats, format to set for writing
+ * \param format format to set for writing
* \return Returns 0 on success, -1 on failure
*/
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
@@ -1827,7 +1827,7 @@
/*!
* \brief Sets write format on channel chan
* \param chan channel to change
- * \param format id to set for writing, only used for formats without attributes
+ * \param id format id to set for writing, only used for formats without attributes
* \return Returns 0 on success, -1 on failure
*/
int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
@@ -2100,7 +2100,7 @@
/*!
* \brief Pick the best codec
*
- * \param capabilities to pick best codec out of
+ * \param cap capabilities to pick best codec out of
* \param result stucture to store the best codec in.
* \retval on success, pointer to result structure
* \retval on failure, NULL
Modified: trunk/include/asterisk/config.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/config.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/config.h (original)
+++ trunk/include/asterisk/config.h Thu Aug 30 09:23:28 2012
@@ -193,7 +193,7 @@
* \brief Sorts categories in a config in the order of a numerical value contained within them.
*
* \param config The config structure you wish to sort
- * \param variable Which numerical value you wish to sort by
+ * \param comparator variable Which numerical value you wish to sort by
* \param descending If true, we sort highest to lowest instead of lowest to highest
*
* \details
@@ -741,9 +741,9 @@
*
* \param arg the string to parse. It is not modified.
* \param flags combination of ast_parse_flags to specify the
- * return type and additional checks.
+ * return type and additional checks.
* \param result pointer to the result. NULL is valid here, and can
- * be used to perform only the validity checks.
+ * be used to perform only the validity checks.
* \param ... extra arguments are required according to flags.
*
* \retval 0 in case of success, != 0 otherwise.
@@ -841,7 +841,7 @@
* \param chunk Data to be decoded
* \return The decoded data, in the original buffer
* \since 1.8
- * \warn This function modifies the original buffer
+ * \warning This function modifies the original buffer
*/
char *ast_realtime_decode_chunk(char *chunk);
Modified: trunk/include/asterisk/config_options.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/config_options.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/config_options.h (original)
+++ trunk/include/asterisk/config_options.h Thu Aug 30 09:23:28 2012
@@ -176,7 +176,6 @@
/*! \def CONFIG_INFO_STANDARD
* \brief Declare an aco_info struct with default module and preload values
* \param name The name of the struct
- * \param fn The filename of the config
* \param arr The global object array for holding the user-defined config object
* \param alloc The allocater for the user-defined config object
*
@@ -462,7 +461,6 @@
* \param info The aco_info to be used for handling the config
* \param file The file attached to aco_info that the config represents
* \param cfg A pointer to a loaded ast_config to parse
- * \param reload Whether or not this is a reload
*
* \retval ACO_PROCESS_OK Success
* \retval ACO_PROCESS_ERROR Failure
@@ -496,7 +494,7 @@
int aco_process_category_options(struct aco_type *type, struct ast_config *cfg, const char *cat, void *obj);
/*! \brief Set all default options of \a obj
- * \param info The aco_type with the options
+ * \param type The aco_type with the options
* \param category The configuration category from which \a obj is being configured
* \param obj The object being configured
*
@@ -511,11 +509,12 @@
*
* \param info The aco_info holding this module's config information
* \param name The name of the option
+ * \param match_type
* \param types An array of valid option types for matching categories to the correct struct type
* \param default_val The default value of the option in the same format as defined in a config file
* \param type The option type (only for default handlers)
* \param handler The handler function for the option (only for non-default types)
- * \param flags \a type specific flags, stored in the option and available to the handler
+ * \param flags a type specific flags, stored in the option and available to the handler
* \param argc The number for variadic arguments
* \param ... field offsets to store for default handlers
*
@@ -528,10 +527,12 @@
/*! \brief Register a config option
* \param info A pointer to the aco_info struct
* \param name The name of the option
+ * \param matchtype
* \param types An array of valid option types for matching categories to the correct struct type
* \param default_val The default value of the option in the same format as defined in a config file
* \param opt_type The option type for default option type handling
- * \param flags \a type specific flags, stored in the option and available to the handler
+ * \param flags a type specific flags, stored in the option and available to the handler
+ * \param ...
*
* \retval 0 Success
* \retval -1 Failure
@@ -542,6 +543,7 @@
/*! \brief Register a config option
* \param info A pointer to the aco_info struct
* \param name The name of the option
+ * \param matchtype
* \param types An array of valid option types for matching categories to the correct struct type
* \param default_val The default value of the option in the same format as defined in a config file
* \param handler The handler callback for the option
@@ -570,14 +572,15 @@
* passed in. It is currently limited to 8 arguments, but 8 variadic
* arguments, like 640K, should be good enough for anyone. If not, it is
* easy to add more.
- * */
-
-/*! \def ARGMAP(func, func_arg, x, ...)
+ *
+ */
+
+/*!
* \brief Map \a func(\a func_arg, field) across all fields including \a x
* \param func The function (almost certainly offsetof) to map across the fields
* \param func_arg The first argument (almost certainly a type (e.g. "struct mystruct")
* \param x The first field
- * \param varargs The rest of the fields
+ * \param ... varargs The rest of the fields
*
* Example usage:
* \code
@@ -588,17 +591,19 @@
* };
* ARGMAP(offsetof, struct foo, a, c)
* \endcode
+ *
* produces the string:
+ *
* \code
* 2, offsetof(struct foo, a), offsetof(struct foo, b)
- * \encode
+ * \endcode
* which can be passed as the varargs to some other function
*
* The macro isn't limited to offsetof, but that is the only purpose for
* which it has been tested.
*
* As an example of how the processing works:
- *
+ * \verbatim
* ARGMAP(offsetof, struct foo, a, b, c) ->
* ARGMAP_(3, offsetof, struct foo, a, b, c) ->
* ARGMAP_3(offsetof, struct foo, 3, a, b, c) ->
@@ -606,12 +611,15 @@
* ARGMAP_1(offsetof, struct foo, ARGIFY(3, offsetof(struct foo, a), offsetof(struct foo, b)), c) ->
* ARGIFY(3, offsetof(struct foo, a), offsetof(struct foo, b), offsetof(struct foo, c)) ->
* 3, offsetof(struct foo, a), offsetof(struct foo, b), offsetof(struct foo, c)
+ * \endverbatim
+ *
*/
#define ARGMAP(func, func_arg, x, ...) ARGMAP_(VA_NARGS(x, ##__VA_ARGS__), func, func_arg, x, __VA_ARGS__)
/*! \note This is sneaky. On the very first argument, we set "in" to N, the number of arguments, so
* that the accumulation both works properly for the first argument (since "in" can't be empty) and
- * we get the number of arguments in our varargs as a bonus */
+ * we get the number of arguments in our varargs as a bonus
+ */
#define ARGMAP_(N, func, func_arg, x, ...) PASTE(ARGMAP_, N)(func, func_arg, N, x, __VA_ARGS__)
/*! \def PASTE(arg1, arg2)
@@ -629,7 +637,7 @@
* \param func_arg The first argument to func (most likely a type e.g. "struct my_struct")
* \param in The accumulated function-mapped field names so far
* \param x The next field name
- * \param varargs The rest of the field names
+ * \param ... varargs The rest of the field names
*/
#define ARGMAP_1(func, func_arg, in, x, ...) ARGIFY(in, func(func_arg, x))
#define ARGMAP_2(func, func_arg, in, x, ...)\
@@ -651,18 +659,19 @@
* \brief Results in the number of arguments passed to it
* \note Currently only up to 8, but expanding is easy. This macro basically counts
* commas + 1. To visualize:
- *
+ * \verbatim
* VA_NARGS(one, two, three) -> v
* VA_NARGS1(one, two, three, 8, 7, 6, 5, 4, 3, 2, 1, 0) ->
* VA_NARGS1( _1, _2, _3, _4, _5, _6, _7, _8, N, ... ) N -> 3
- *
+ *
* Note that VA_NARGS *does not* work when there are no arguments passed. Pasting an empty
* __VA_ARGS__ with a comma like ", ##__VA_ARGS__" will delete the leading comma, but it
* does not work when __VA_ARGS__ is the first argument. Instead, 1 is returned instead of 0:
- *
+ *
* VA_NARGS() -> v
* VA_NARGS1( , 8, 7, 6, 5, 4, 3, 2, 1, 0) ->
* VA_NARGS1(_1, _2, _3, _4, _5, _6, _7, _8, N) -> 1
+ * \endverbatim
*/
#define VA_NARGS(...) VA_NARGS1(__VA_ARGS__, 8, 7, 6, 5, 4, 3, 2, 1, 0)
#define VA_NARGS1(_1, _2, _3, _4, _5, _6, _7, _8, N, ...) N
@@ -670,7 +679,7 @@
/*! \def FLDSET(type, ...)
* \brief Convert a struct and list of fields to an argument list of field offsets
* \param type The type with the fields (e.g. "struct my_struct")
- * \param varags The fields in the struct whose offsets are needed as arguments
+ * \param ... varags The fields in the struct whose offsets are needed as arguments
*
* For example:
* \code
@@ -692,7 +701,7 @@
* default stringfield option handler, so registering options that point to stringfields requires
* this macro to be called instead of the FLDSET macro.
* \param type The type with the fields (e.g. "struct my_struct")
- * \param varargs The fields in the struct whose offsets are needed as arguments
+ * \param ... varargs The fields in the struct whose offsets are needed as arguments
*/
#define STRFLDSET(type, ...) FLDSET(type, __VA_ARGS__, __field_mgr_pool, __field_mgr)
@@ -710,9 +719,10 @@
* FLDSET. This is because a call to FLDSET may be followed by additional arguments in
* aco_register_option, so the true number of arguments will possibly be different than what
* ARGMAP returns.
- * \params varags A list of arguments
- *
+ * \param ... varags A list of arguments
+ * \verbatim
* POPPED(a, b, c) -> b, c
+ * \endverbatim
*/
#define POPPED(...) POPPED1(__VA_ARGS__)
#define POPPED1(x, ...) __VA_ARGS__
Modified: trunk/include/asterisk/crypto.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/crypto.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/crypto.h (original)
+++ trunk/include/asterisk/crypto.h Thu Aug 30 09:23:28 2012
@@ -46,8 +46,8 @@
/*!
* \brief Retrieve a key
- * \param name of the key we are retrieving
- * \param int type of key (AST_KEY_PUBLIC or AST_KEY_PRIVATE)
+ * \param key Name of the key we are retrieving
+ * \param type Intger type of key (AST_KEY_PUBLIC or AST_KEY_PRIVATE)
*
* \retval the key on success.
* \retval NULL on failure.
@@ -70,6 +70,7 @@
* \brief Check the authenticity of a message signature using a given public key
* \param key a public key to use to verify
* \param msg the message that has been signed
+ * \param msglen
* \param sig the proposed valid signature in raw binary representation
*
* \retval 0 if the signature is valid.
@@ -95,6 +96,7 @@
* \brief Sign a message signature using a given private key
* \param key a private key to use to create the signature
* \param msg the message to sign
+ * \param msglen
* \param sig a pointer to a buffer of at least 128 bytes in which the
* raw encoded signature will be stored
*
Modified: trunk/include/asterisk/datastore.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/datastore.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/datastore.h (original)
+++ trunk/include/asterisk/datastore.h Thu Aug 30 09:23:28 2012
@@ -63,6 +63,7 @@
* \brief Create a data store object
* \param[in] info information describing the data store object
* \param[in] uid unique identifer
+ * \param file, line, function
* \version 1.6.1 moved here and renamed from ast_channel_datastore_alloc
*/
struct ast_datastore * attribute_malloc __ast_datastore_alloc(const struct ast_datastore_info *info, const char *uid,
Modified: trunk/include/asterisk/format.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/format.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/format.h (original)
+++ trunk/include/asterisk/format.h Thu Aug 30 09:23:28 2012
@@ -264,9 +264,9 @@
* with optional format attributes represented by format specific key value pairs.
*
* \param format to set
- * \param id, format id to set on format
+ * \param id format id to set on format
* \param set_attributes, are there attributes to set on this format. 0 == false, 1 == True.
- * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
+ * \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
*
* \details Example usage.
* ast_format_set(format, AST_FORMAT_ULAW, 0); // no capability attributes are needed for ULAW
@@ -290,7 +290,7 @@
* set additional format attributes to the structure.
*
* \param format to set
- * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
+ * \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
*
* \details Example usage.
* ast_format_set(format, AST_FORMAT_SILK, 0);
@@ -421,7 +421,7 @@
/*! \brief Returns a string containing all formats pertaining to an format id.
* \param buf a buffer for the output string
* \param size size of buf (bytes)
- * \param format id.
+ * \param id format id.
* \return The return value is buf.
*/
char* ast_getformatname_multiple_byid(char *buf, size_t size, enum ast_format_id id);
Modified: trunk/include/asterisk/format_cap.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/format_cap.h?view=diff&rev=371989&r1=371988&r2=371989
==============================================================================
--- trunk/include/asterisk/format_cap.h (original)
+++ trunk/include/asterisk/format_cap.h Thu Aug 30 09:23:28 2012
@@ -119,7 +119,7 @@
/*!
* \brief Remove format capability from capability structure.
*
- * \Note format must match Exactly to format in ast_format_cap object in order
+ * \note format must match Exactly to format in ast_format_cap object in order
* to be removed.
*
* \retval 0, remove was successful
@@ -131,7 +131,7 @@
* \brief Remove all format capabilities from capability
* structure for a specific format id.
*
[... 553 lines stripped ...]
More information about the svn-commits
mailing list