diff options
| author | Andrew Latham <lathama@gmail.com> | 2012-09-21 17:14:59 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2012-09-21 17:14:59 +0000 |
| commit | 6f61cb50c5d809173dc6eb8904da7a8beed65a24 (patch) | |
| tree | 811c751517ac0237aada04479ffc6b246f0f230e /apps | |
| parent | 448098ca9fd1626330bbb24912f2829e9b56acff (diff) | |
Doxygen Updates - janitor work
Doxygen updates including mistakes, misspellings, missing parameters, updates for Doxygen style. Some missing txt file links are removed but their content or essense will be included in some later updates. A majority of the txt files were removed in the 1.6 era but never noted. The HR and EXTREF are simple changes that make the documentation more compatable with more versions of Doxygen.
Further updates coming.
(issue ASTERISK-20259)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373330 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps')
| -rw-r--r-- | apps/app_confbridge.c | 4 | ||||
| -rw-r--r-- | apps/app_ices.c | 2 | ||||
| -rw-r--r-- | apps/app_meetme.c | 1 | ||||
| -rw-r--r-- | apps/app_skel.c | 10 |
4 files changed, 13 insertions, 4 deletions
diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c index adbe0d150..e6ee85b99 100644 --- a/apps/app_confbridge.c +++ b/apps/app_confbridge.c @@ -621,7 +621,7 @@ static void send_leave_event(struct ast_channel *chan, const char *conf_name) * \brief Announce number of users in the conference bridge to the caller * * \param conference_bridge Conference bridge to peek at - * \param (OPTIONAL) conference_bridge_user Caller + * \param conference_bridge_user Optional Caller * * \note if caller is NULL, the announcment will be sent to all participants in the conference. * \return Returns 0 on success, -1 if the user hung up @@ -1258,7 +1258,7 @@ static int play_sound_file(struct conference_bridge *conference_bridge, const ch * \brief Play number into the conference bridge * * \param conference_bridge The conference bridge to say the number into - * \param number to say + * \param say_number number to say * * \retval 0 success * \retval -1 failure diff --git a/apps/app_ices.c b/apps/app_ices.c index 3ed52273d..bdccff43f 100644 --- a/apps/app_ices.c +++ b/apps/app_ices.c @@ -22,7 +22,7 @@ * * \author Mark Spencer <markster@digium.com> * - * \extref ICES - http://www.icecast.org/ices.php + * ICES - http://www.icecast.org/ices.php * * \ingroup applications */ diff --git a/apps/app_meetme.c b/apps/app_meetme.c index 1409f460f..0cab44c7c 100644 --- a/apps/app_meetme.c +++ b/apps/app_meetme.c @@ -1217,6 +1217,7 @@ static int user_max_cmp(void *obj, void *arg, int flags) * \param dynamic Mark the newly created conference as dynamic * \param refcount How many references to mark on the conference * \param chan The asterisk channel + * \param test * * \return A pointer to the conference struct, or NULL if it wasn't found and * make or dynamic were not set. diff --git a/apps/app_skel.c b/apps/app_skel.c index ca96fa08f..17412bf64 100644 --- a/apps/app_skel.c +++ b/apps/app_skel.c @@ -178,7 +178,7 @@ static void *skel_level_alloc(const char *cat); * internally by the Config Options code to check if an level has already been added to the * container that will be swapped for the live container on a successul reload. * - * \param container A non-active container to search for a level + * \param tmp_container A non-active container to search for a level * \param category The category associated with the level to check for * \retval non-NULL The level from the container * \retval NULL The level does not exist in the container @@ -648,6 +648,14 @@ static int unload_module(void) return ast_unregister_application(app); } +/*! + * \brief Load the module + * + * \par The configuration file + * + * The application app_skel uses a configuration file. + * \verbinclude app_skel.conf.sample + */ static int load_module(void) { if (aco_info_init(&cfg_info)) { |