summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlfred E. Heggestad <alfred.heggestad@gmail.com>2017-03-04 15:41:38 +0100
committerAlfred E. Heggestad <alfred.heggestad@gmail.com>2017-03-04 15:41:38 +0100
commit0553f35426493a8f3e02c6d2fca91df447dcce56 (patch)
treeababaaaa0980ed79b7cbe0ab22711f04a328a0fe
parent4f43acb07de88433ce513079233040e3e7c2b9d6 (diff)
update doxygen comments
fix all warnings reported by doxygen version 1.8.13 (make dox)
-rw-r--r--modules/amr/amr.c1
-rw-r--r--modules/avcodec/h263.c16
-rw-r--r--modules/g722/g722.c1
-rw-r--r--modules/ilbc/ilbc.c1
-rw-r--r--modules/isac/isac.c1
-rw-r--r--modules/silk/silk.c1
-rw-r--r--src/sdp.c5
-rw-r--r--src/ua.c5
8 files changed, 24 insertions, 7 deletions
diff --git a/modules/amr/amr.c b/modules/amr/amr.c
index 52c20b3..885a318 100644
--- a/modules/amr/amr.c
+++ b/modules/amr/amr.c
@@ -336,7 +336,6 @@ static int module_close(void)
}
-/** Module exports */
EXPORT_SYM const struct mod_export DECL_EXPORTS(amr) = {
"amr",
"codec",
diff --git a/modules/avcodec/h263.c b/modules/avcodec/h263.c
index 7e29ecd..5ee016e 100644
--- a/modules/avcodec/h263.c
+++ b/modules/avcodec/h263.c
@@ -110,7 +110,14 @@ int h263_hdr_decode(struct h263_hdr *hdr, struct mbuf *mb)
}
-/** Find PSC (Picture Start Code) in bit-stream */
+/**
+ * Find PSC (Picture Start Code) in bit-stream
+ *
+ * @param p Input bit-stream
+ * @param size Number of bytes in bit-stream
+ *
+ * @return Pointer to PSC if found, otherwise NULL
+ */
const uint8_t *h263_strm_find_psc(const uint8_t *p, uint32_t size)
{
const uint8_t *end = p + size - 1;
@@ -157,7 +164,12 @@ int h263_strm_decode(struct h263_strm *s, struct mbuf *mb)
}
-/** Copy H.263 bit-stream to H.263 RTP payload header */
+/**
+ * Copy H.263 bit-stream to H.263 RTP payload header
+ *
+ * @param hdr H.263 header to be written to
+ * @param s H.263 stream header
+ */
void h263_hdr_copy_strm(struct h263_hdr *hdr, const struct h263_strm *s)
{
hdr->f = 0; /* Mode A */
diff --git a/modules/g722/g722.c b/modules/g722/g722.c
index fae0958..16d1f98 100644
--- a/modules/g722/g722.c
+++ b/modules/g722/g722.c
@@ -183,7 +183,6 @@ static int module_close(void)
}
-/** Module exports */
EXPORT_SYM const struct mod_export DECL_EXPORTS(g722) = {
"g722",
"codec",
diff --git a/modules/ilbc/ilbc.c b/modules/ilbc/ilbc.c
index 918f7fc..3628e11 100644
--- a/modules/ilbc/ilbc.c
+++ b/modules/ilbc/ilbc.c
@@ -349,7 +349,6 @@ static int module_close(void)
}
-/** Module exports */
EXPORT_SYM const struct mod_export DECL_EXPORTS(ilbc) = {
"ilbc",
"codec",
diff --git a/modules/isac/isac.c b/modules/isac/isac.c
index 868ef0e..eb4bbdd 100644
--- a/modules/isac/isac.c
+++ b/modules/isac/isac.c
@@ -218,7 +218,6 @@ static int module_close(void)
}
-/** Module exports */
EXPORT_SYM const struct mod_export DECL_EXPORTS(isac) = {
"isac",
"codec",
diff --git a/modules/silk/silk.c b/modules/silk/silk.c
index f1aba89..dee296c 100644
--- a/modules/silk/silk.c
+++ b/modules/silk/silk.c
@@ -254,7 +254,6 @@ static int module_close(void)
}
-/** Module exports */
EXPORT_SYM const struct mod_export DECL_EXPORTS(silk) = {
"silk",
"codec",
diff --git a/src/sdp.c b/src/sdp.c
index 8001253..da4889c 100644
--- a/src/sdp.c
+++ b/src/sdp.c
@@ -144,6 +144,11 @@ static void decode_part(const struct pl *part, struct mbuf *mb)
/**
* Decode a multipart/mixed message and find the part with application/sdp
+ *
+ * @param ctype_prm Content type parameter
+ * @param mb Mbuffer containing the SDP
+ *
+ * @return 0 if success, otherwise errorcode
*/
int sdp_decode_multipart(const struct pl *ctype_prm, struct mbuf *mb)
{
diff --git a/src/ua.c b/src/ua.c
index 5dbc68a..8a2bc61 100644
--- a/src/ua.c
+++ b/src/ua.c
@@ -1537,6 +1537,11 @@ int ua_print_sip_status(struct re_printf *pf, void *unused)
/**
* Print all calls for a given User-Agent
+ *
+ * @param pf Print handler for debug output
+ * @param ua User-Agent
+ *
+ * @return 0 if success, otherwise errorcode
*/
int ua_print_calls(struct re_printf *pf, const struct ua *ua)
{