diff options
| author | Russell Bryant <russell@russellbryant.com> | 2006-02-18 02:45:38 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2006-02-18 02:45:38 +0000 |
| commit | df05e39e8439b6e696897d7ccf04b240d6fbc5cf (patch) | |
| tree | 0ab4ca4d69029b35d17d28ab4411bd4f9ac3329a /include | |
| parent | 08132bdf001990dcce7165e0ef1d894313748f8d (diff) | |
fix up some doxygen formatted comments
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@10432 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
| -rw-r--r-- | include/asterisk/translate.h | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index 07233e68f..118ba6d55 100644 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -63,32 +63,33 @@ struct ast_translator { struct ast_trans_pvt; -/*! Register a translator */ -/*! +/*! + * \brief Register a translator * \param t populated ast_translator structure * This registers a codec translator with asterisk * Returns 0 on success, -1 on failure */ extern int ast_register_translator(struct ast_translator *t); -/*! Unregister a translator */ /*! + * \brief Unregister a translator * \param t translator to unregister * Unregisters the given tranlator * Returns 0 on success, -1 on failure */ 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 - I choose? Returns 0 on success, -1 if no path could be found. Modifies - dests and srcs in place - */ + * I choose? Returns 0 on success, -1 if no path could be found. Modifies + * dests and srcs in place + */ extern int ast_translator_best_choice(int *dsts, int *srcs); -/*!Builds a translator path */ /*! + * \brief Builds a translator path * \param dest destination format * \param source source format * 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); -/*! Frees a translator path */ /*! + * \brief Frees a translator path * \param tr translator path to get rid of * Frees the given translator path structure */ 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 f frame to translate * \param consume Whether or not to free the original frame |