diff options
author | kpfleming <kpfleming@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-05-09 16:24:07 +0000 |
---|---|---|
committer | kpfleming <kpfleming@f38db490-d61c-443f-a65b-d21fe96a405b> | 2006-05-09 16:24:07 +0000 |
commit | f1898a71f11389c69333a2d3ab5ceb5ca4f252d0 (patch) | |
tree | cbee3b6bd1df69ca7b222c47ef446c7f204283a0 /include/asterisk | |
parent | 9a07e634fda5a8805e32953516a6271b1fb73904 (diff) |
various doxygen fixes
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@26170 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk')
-rw-r--r-- | include/asterisk/astosp.h | 3 | ||||
-rw-r--r-- | include/asterisk/channel.h | 7 | ||||
-rw-r--r-- | include/asterisk/frame.h | 36 | ||||
-rw-r--r-- | include/asterisk/module.h | 6 | ||||
-rw-r--r-- | include/asterisk/translate.h | 1 |
5 files changed, 30 insertions, 23 deletions
diff --git a/include/asterisk/astosp.h b/include/asterisk/astosp.h index b7ef46598..6861dca1b 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 770f8ce14..00001f059 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 09d8674b2..71e4ca908 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 1b1e434a6..2b94bae26 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 6d5ed1526..d1431b3be 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 */ |