diff options
author | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-12-11 22:20:22 +0000 |
---|---|---|
committer | oej <oej@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-12-11 22:20:22 +0000 |
commit | c7aed6ea2b8ae6c4e57e0d334969c5f639bbf6fa (patch) | |
tree | 0a9803469fbf5f68d50c1ad88e82840333144ca0 /include/asterisk/translate.h | |
parent | bf3d4cdd5e60d91b081b7d86ce2b651e39d194d7 (diff) |
Doxygen updates, formatting.
misdn stuff needs a lot of doxygenification
(Hello, Qwell :-) )
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@92423 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'include/asterisk/translate.h')
-rw-r--r-- | include/asterisk/translate.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index 75023f0ad..2db3019c1 100644 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -18,6 +18,7 @@ /*! \file * \brief Support for translation of data formats. + * \ref translate.c */ #ifndef _ASTERISK_TRANSLATE_H @@ -40,7 +41,9 @@ extern "C" { struct ast_trans_pvt; /* declared below */ /*! \brief - * Descriptor of a translator. Name, callbacks, and various options + * Descriptor of a translator. + * + * Name, callbacks, and various options * related to run-time operation (size of buffers, auxiliary * descriptors, etc). * @@ -116,7 +119,7 @@ struct ast_translator { /*! \brief * Default structure for translators, with the basic fields and buffers, * all allocated as part of the same chunk of memory. The buffer is - * preceded by AST_FRIENDLY_OFFSET bytes in front of the user portion. + * preceded by \ref AST_FRIENDLY_OFFSET bytes in front of the user portion. * 'buf' points right after this space. * * *_framein() routines operate in two ways: @@ -158,6 +161,8 @@ struct ast_trans_pvt; * \return 0 on success, -1 on failure */ int __ast_register_translator(struct ast_translator *t, struct ast_module *module); + +/*! \brief See \ref __ast_register_translator() */ #define ast_register_translator(t) __ast_register_translator(t, ast_module_info->self) /*! |