summaryrefslogtreecommitdiff
path: root/main
diff options
context:
space:
mode:
authorMatthew Jordan <mjordan@digium.com>2012-08-30 14:23:28 +0000
committerMatthew Jordan <mjordan@digium.com>2012-08-30 14:23:28 +0000
commit8018b879a2a77a9408b7c848dc550c8f1ae5a15a (patch)
treeca11d0062aa2dabe13e1ff45a2e95ceb96ba39f1 /main
parent4781be6e934065ab0de59455c24e757a17f3f0e8 (diff)
Clean up doxygen warnings
This patch fixes numerous doxygen warnings across Asterisk. It also updates the makefile to regenerate the doxygen configuration on the local system before running doxygen to help prevent warnings/errors on the local system. Much thanks to Andrew for tackling one of the Asterisk janitor projects! (issue ASTERISK-20259) Reported by: Andrew Latham Patches: doxygen_partial.diff uploaded by Andrew Latham (license 5985) make_progdocs.diff uploaded by Andrew Latham (license 5985) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@371989 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main')
-rw-r--r--main/audiohook.c2
-rw-r--r--main/cdr.c5
-rw-r--r--main/channel.c5
-rw-r--r--main/file.c12
-rw-r--r--main/named_acl.c2
-rw-r--r--main/pbx.c9
6 files changed, 24 insertions, 11 deletions
diff --git a/main/audiohook.c b/main/audiohook.c
index 679e27c1a..0ca727d4e 100644
--- a/main/audiohook.c
+++ b/main/audiohook.c
@@ -99,7 +99,7 @@ static int audiohook_set_internal_rate(struct ast_audiohook *audiohook, int rate
/*! \brief Initialize an audiohook structure
* \param audiohook Audiohook structure
* \param type
- * \param source
+ * \param init, source, init_flags
* \return Returns 0 on success, -1 on failure
*/
int ast_audiohook_init(struct ast_audiohook *audiohook, enum ast_audiohook_type type, const char *source, enum ast_audiohook_init_flags init_flags)
diff --git a/main/cdr.c b/main/cdr.c
index 053c86b9e..a6ac5be1e 100644
--- a/main/cdr.c
+++ b/main/cdr.c
@@ -1013,7 +1013,10 @@ char *ast_cdr_disp2str(int disposition)
return "UNKNOWN";
}
-/*! Converts AMA flag to printable string */
+/*! Converts AMA flag to printable string
+ *
+ * \param flag, flags
+ */
char *ast_cdr_flags2str(int flag)
{
switch (flag) {
diff --git a/main/channel.c b/main/channel.c
index 872e844d8..66d7ef588 100644
--- a/main/channel.c
+++ b/main/channel.c
@@ -811,7 +811,10 @@ int ast_str2cause(const char *name)
}
/*! \brief Gives the string form of a given channel state.
- \note This function is not reentrant.
+ *
+ * \note This function is not reentrant.
+ *
+ * \param state
*/
const char *ast_state2str(enum ast_channel_state state)
{
diff --git a/main/file.c b/main/file.c
index 8ff88e7da..915ed98d6 100644
--- a/main/file.c
+++ b/main/file.c
@@ -601,12 +601,12 @@ static int fileexists_test(const char *filename, const char *fmt, const char *la
* \note The last parameter(s) point to a buffer of sufficient size,
* which on success is filled with the matching filename.
*
- * \param filename, name of the file.
- * \param fmt, format to look for the file in. OPTIONAL
- * \param preflang, the perfered language
- * \param buf, returns the matching filename
- * \param buflen, size of the buf
- * \param result_cap, OPTIONAL format capabilities result structure
+ * \param filename Name of the file.
+ * \param fmt Format to look for the file in. OPTIONAL
+ * \param preflang The perfered language
+ * \param buf Returns the matching filename
+ * \param buflen Size of the buf
+ * \param result_cap OPTIONAL format capabilities result structure
* returns what formats the file was found in.
*
* \retval 1, true. file exists and result format is set
diff --git a/main/named_acl.c b/main/named_acl.c
index cd6a8d68d..1638459fe 100644
--- a/main/named_acl.c
+++ b/main/named_acl.c
@@ -195,7 +195,7 @@ void *named_acl_alloc(const char *cat)
* \brief Find a named ACL in a container by its name
*
* \param container ao2container holding the named ACLs
- * \param name of the ACL wanted to be found
+ * \param cat name of the ACL wanted to be found
* \retval pointer to the named ACL if available. Null if not found.
*/
void *named_acl_find(struct ao2_container *container, const char *cat)
diff --git a/main/pbx.c b/main/pbx.c
index e76f6d779..1acb811a4 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -6794,6 +6794,7 @@ int ast_context_remove_extension_callerid2(struct ast_context *con, const char *
* \note This function locks contexts list by &conlist, searches for the right context
* structure, and locks the macrolock mutex in that context.
* macrolock is used to limit a macro to be executed by one call at a time.
+ * \param context The context
*/
int ast_context_lockmacro(const char *context)
{
@@ -6815,6 +6816,7 @@ int ast_context_lockmacro(const char *context)
* \note This function locks contexts list by &conlist, searches for the right context
* structure, and unlocks the macrolock mutex in that context.
* macrolock is used to limit a macro to be executed by one call at a time.
+ * \param context The context
*/
int ast_context_unlockmacro(const char *context)
{
@@ -8796,7 +8798,12 @@ static const char * const months[] =
"dec",
NULL,
};
-
+/*! /brief Build timing
+ *
+ * /param i, info
+ * /param info_in
+ *
+ */
int ast_build_timing(struct ast_timing *i, const char *info_in)
{
char *info;