kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-18 15:49:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix up some doxygen formatted comments

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@10432 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2006-02-18 02:45:38 +00:00
parent 08132bdf00
commit df05e39e84
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/asterisk/translate.h
View File

@@ -63,32 +63,33 @@ struct ast_translator {
struct ast_trans_pvt; struct ast_trans_pvt;
/*! Register a translator */
/*! /*!
* \brief Register a translator
* \param t populated ast_translator structure * \param t populated ast_translator structure
* This registers a codec translator with asterisk * This registers a codec translator with asterisk
* Returns 0 on success, -1 on failure * Returns 0 on success, -1 on failure
*/ */
extern int ast_register_translator(struct ast_translator *t); extern int ast_register_translator(struct ast_translator *t);
/*! Unregister a translator */
/*! /*!
* \brief Unregister a translator
* \param t translator to unregister * \param t translator to unregister
* Unregisters the given tranlator * Unregisters the given tranlator
* Returns 0 on success, -1 on failure * Returns 0 on success, -1 on failure
*/ */
extern int ast_unregister_translator(struct ast_translator *t); extern int ast_unregister_translator(struct ast_translator *t);
/*! Chooses the best translation path */
/*! /*!
* \brief Chooses the best translation path
*
* Given a list of sources, and a designed destination format, which should * Given a list of sources, and a designed destination format, which should
I choose? Returns 0 on success, -1 if no path could be found. Modifies * I choose? Returns 0 on success, -1 if no path could be found. Modifies
dests and srcs in place * dests and srcs in place
*/ */
extern int ast_translator_best_choice(int *dsts, int *srcs); extern int ast_translator_best_choice(int *dsts, int *srcs);
/*!Builds a translator path */
/*! /*!
* \brief Builds a translator path
* \param dest destination format * \param dest destination format
* \param source source format * \param source source format
* Build a path (possibly NULL) from source to dest * Build a path (possibly NULL) from source to dest
@@ -96,15 +97,15 @@ extern int ast_translator_best_choice(int *dsts, int *srcs);
* */ * */
extern struct ast_trans_pvt *ast_translator_build_path(int dest, int source); extern struct ast_trans_pvt *ast_translator_build_path(int dest, int source);
/*! Frees a translator path */
/*! /*!
* \brief Frees a translator path
* \param tr translator path to get rid of * \param tr translator path to get rid of
* Frees the given translator path structure * Frees the given translator path structure
*/ */
extern void ast_translator_free_path(struct ast_trans_pvt *tr); extern void ast_translator_free_path(struct ast_trans_pvt *tr);
/*! translates one or more frames */
/*! /*!
* \brief translates one or more frames
* \param tr translator structure to use for translation * \param tr translator structure to use for translation
* \param f frame to translate * \param f frame to translate
* \param consume Whether or not to free the original frame * \param consume Whether or not to free the original frame