From ed3ffb4b46e5ea11dd78568dc85555ce39c35831 Mon Sep 17 00:00:00 2001
From: "Kevin P. Fleming" <kpfleming@digium.com>
Date: Tue, 9 May 2006 16:24:07 +0000
Subject: [PATCH] various doxygen fixes
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@26170 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
include/asterisk/astosp.h | 3 ++-
include/asterisk/channel.h | 7 +++++++
include/asterisk/frame.h | 36 ++++++++++++++++++------------------
include/asterisk/module.h | 6 ++----
include/asterisk/translate.h | 1 +
pbx.c | 4 ++--
pbx/pbx_config.c | 2 +-
res/res_smdi.c | 6 +++---
8 files changed, 36 insertions(+), 29 deletions(-)
diff --git a/include/asterisk/astosp.h b/include/asterisk/astosp.h
index b7ef465985..6861dca1b1 100644
--- a/include/asterisk/astosp.h
+++ b/include/asterisk/astosp.h
@@ -112,7 +112,8 @@ int ast_osp_next(
* \param handle OSP in/out_bound transaction handle
* \param reason Last destination failure reason
* \param start Call start time
- * \param duration Call duration
+ * \param connect Call connect time
+ * \param end Call end time
* \return 1 Success, 0 Failed, -1 Error
*/
int ast_osp_finish(
diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index 770f8ce145..00001f059e 100644
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -625,6 +625,13 @@ int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type cont
The supplied payload data is copied into the frame, so the caller's copy
is not modified nor freed, and the resulting frame will retain a copy of
the data even if the caller frees their local copy.
+
+ \note This method should be treated as a 'network transport'; in other
+ words, your frames may be transferred across an IAX2 channel to another
+ system, which may be a different endianness than yours. Because of this,
+ you should ensure that either your frames will never be expected to work
+ across systems, or that you always put your payload data into 'network byte
+ order' before calling this function.
*/
int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
const void *data, size_t datalen);
diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h
index 09d8674b2a..71e4ca908e 100644
--- a/include/asterisk/frame.h
+++ b/include/asterisk/frame.h
@@ -241,24 +241,24 @@ extern struct ast_frame ast_null_frame;
#define AST_FORMAT_VIDEO_MASK (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))
enum ast_control_frame_type {
- AST_CONTROL_HANGUP = 1, /*! Other end has hungup */
- AST_CONTROL_RING = 2, /*! Local ring */
- AST_CONTROL_RINGING = 3, /*! Remote end is ringing */
- AST_CONTROL_ANSWER = 4, /*! Remote end has answered */
- AST_CONTROL_BUSY = 5, /*! Remote end is busy */
- AST_CONTROL_TAKEOFFHOOK = 6, /*! Make it go off hook */
- AST_CONTROL_OFFHOOK = 7, /*! Line is off hook */
- AST_CONTROL_CONGESTION = 8, /*! Congestion (circuits busy) */
- AST_CONTROL_FLASH = 9, /*! Flash hook */
- AST_CONTROL_WINK = 10, /*! Wink */
- AST_CONTROL_OPTION = 11, /*! Set a low-level option */
- AST_CONTROL_RADIO_KEY = 12, /*! Key Radio */
- AST_CONTROL_RADIO_UNKEY = 13, /*! Un-Key Radio */
- AST_CONTROL_PROGRESS = 14, /*! Indicate PROGRESS */
- AST_CONTROL_PROCEEDING = 15, /*! Indicate CALL PROCEEDING */
- AST_CONTROL_HOLD = 16, /*! Indicate call is placed on hold */
- AST_CONTROL_UNHOLD = 17, /*! Indicate call is left from hold */
- AST_CONTROL_VIDUPDATE = 18, /*! Indicate video frame update */
+ AST_CONTROL_HANGUP = 1, /*!< Other end has hungup */
+ AST_CONTROL_RING = 2, /*!< Local ring */
+ AST_CONTROL_RINGING = 3, /*!< Remote end is ringing */
+ AST_CONTROL_ANSWER = 4, /*!< Remote end has answered */
+ AST_CONTROL_BUSY = 5, /*!< Remote end is busy */
+ AST_CONTROL_TAKEOFFHOOK = 6, /*!< Make it go off hook */
+ AST_CONTROL_OFFHOOK = 7, /*!< Line is off hook */
+ AST_CONTROL_CONGESTION = 8, /*!< Congestion (circuits busy) */
+ AST_CONTROL_FLASH = 9, /*!< Flash hook */
+ AST_CONTROL_WINK = 10, /*!< Wink */
+ AST_CONTROL_OPTION = 11, /*!< Set a low-level option */
+ AST_CONTROL_RADIO_KEY = 12, /*!< Key Radio */
+ AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
+ AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */
+ AST_CONTROL_PROCEEDING = 15, /*!< Indicate CALL PROCEEDING */
+ AST_CONTROL_HOLD = 16, /*!< Indicate call is placed on hold */
+ AST_CONTROL_UNHOLD = 17, /*!< Indicate call is left from hold */
+ AST_CONTROL_VIDUPDATE = 18, /*!< Indicate video frame update */
};
#define AST_SMOOTHER_FLAG_G729 (1 << 0)
diff --git a/include/asterisk/module.h b/include/asterisk/module.h
index 1b1e434a61..2b94bae260 100644
--- a/include/asterisk/module.h
+++ b/include/asterisk/module.h
@@ -77,8 +77,7 @@ int ast_load_resource(const char *resource_name);
/*!
* \brief Unloads a module.
* \param resource_name The name of the module to unload.
- * \param force The force flag. This should be set using one of the AST_FORCE*
- * flags.
+ * \param unload_mode The force flag. This should be set using one of the AST_FORCE flags.
*
* This function unloads a module. It will only unload modules that are not in
* use (usecount not zero), unless #AST_FORCE_FIRM or #AST_FORCE_HARD is
@@ -177,9 +176,8 @@ void ast_hangup_localusers(struct module_symbols *);
* whose functions are exported through fields of a "struct module_symbol";
*
* Modules exporting extra symbols (data or functions), should list
- * them into an array of struct symbol_entry: \r
+ * them into an array of struct symbol_entry:
* struct symbol_entry exported_symbols[]
- * \r
* of symbols, with a NULL name on the last entry
*
* Functions should be added with MOD_FUNC(name),
diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h
index 6d5ed15262..d1431b3be0 100644
--- a/include/asterisk/translate.h
+++ b/include/asterisk/translate.h
@@ -146,6 +146,7 @@ struct ast_trans_pvt;
/*!
* \brief Register a translator
* \param t populated ast_translator structure
+ * \param module handle to the module that owns this translator
* This registers a codec translator with asterisk
* \return 0 on success, -1 on failure
*/
diff --git a/pbx.c b/pbx.c
index 4662d79c2a..437fc658ca 100644
--- a/pbx.c
+++ b/pbx.c
@@ -173,7 +173,7 @@ struct ast_context {
struct ast_app {
int (*execute)(struct ast_channel *chan, void *data);
const char *synopsis; /*!< Synopsis text for 'show applications' */
- const char *description; /*!< Description (help text) for 'show application <name>' */
+ const char *description; /*!< Description (help text) for 'show application <name>' */
AST_LIST_ENTRY(ast_app) list; /*!< Next app in list */
struct module *module; /*!< Module this app belongs to */
char name[0]; /*!< Name of the application */
@@ -1230,7 +1230,7 @@ int ast_custom_function_register(struct ast_custom_function *acf)
}
/*! \brief return a pointer to the arguments of the function,
- * and terminates the function name with '\0'
+ * and terminates the function name with '\\0'
*/
static char *func_args(char *function)
{
diff --git a/pbx/pbx_config.c b/pbx/pbx_config.c
index 2fc9fcd63e..d8f4d6d768 100644
--- a/pbx/pbx_config.c
+++ b/pbx/pbx_config.c
@@ -191,7 +191,7 @@ static int partial_match(const char *s, const char *word, int len)
return (len == 0 || !strncmp(s, word, len));
}
-/*! \brief split extension@context in two parts, return -1 on error.
+/*! \brief split extension\@context in two parts, return -1 on error.
* The return string is malloc'ed and pointed by *ext
*/
static int split_ec(const char *src, char **ext, char ** const ctx)
diff --git a/res/res_smdi.c b/res/res_smdi.c
index 2f8515440c..bc9eae1600 100644
--- a/res/res_smdi.c
+++ b/res/res_smdi.c
@@ -150,7 +150,7 @@ int ast_smdi_mwi_unset(struct ast_smdi_interface *iface, const char *mailbox)
/*!
* \brief Put an SMDI message back in the front of the queue.
* \param iface a pointer to the interface to use.
- * \param msg a pointer to the message to use.
+ * \param md_msg a pointer to the message to use.
*
* This function puts a message back in the front of the specified queue. It
* should be used if a message was popped but is not going to be processed for
@@ -164,7 +164,7 @@ void ast_smdi_md_message_putback(struct ast_smdi_interface *iface, struct ast_sm
/*!
* \brief Put an SMDI message back in the front of the queue.
* \param iface a pointer to the interface to use.
- * \param msg a pointer to the message to use.
+ * \param mwi_msg a pointer to the message to use.
*
* This function puts a message back in the front of the specified queue. It
* should be used if a message was popped but is not going to be processed for
@@ -326,7 +326,7 @@ extern struct ast_smdi_interface *ast_smdi_interface_find(const char *iface_name
/*! \brief Read an SMDI message.
*
- * \param iface the SMDI interface to read from.
+ * \param iface_p the SMDI interface to read from.
*
* This function loops and reads from and SMDI interface. It must be stopped
* using pthread_cancel().
--
GitLab