summaryrefslogtreecommitdiff
path: root/pjlib-util/include
diff options
context:
space:
mode:
authorBenny Prijono <bennylp@teluu.com>2008-01-25 16:06:33 +0000
committerBenny Prijono <bennylp@teluu.com>2008-01-25 16:06:33 +0000
commitd583515e9daac73925c0cb1f617aa124666e5b34 (patch)
treec3c741cc68ecba2e1f414dee164d3c8e9a4e1a03 /pjlib-util/include
parent1357c18f2e4cb7f2d9bddf1afb3603991b5ca08b (diff)
Fixed doxygen comments everywhere
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1748 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjlib-util/include')
-rw-r--r--pjlib-util/include/pjlib-util/md5.h6
-rw-r--r--pjlib-util/include/pjlib-util/scanner_cis_uint.h2
-rw-r--r--pjlib-util/include/pjlib-util/sha1.h6
-rw-r--r--pjlib-util/include/pjlib-util/srv_resolver.h2
-rw-r--r--pjlib-util/include/pjlib-util/xml.h7
5 files changed, 12 insertions, 11 deletions
diff --git a/pjlib-util/include/pjlib-util/md5.h b/pjlib-util/include/pjlib-util/md5.h
index 45c9bbef..a0dabf24 100644
--- a/pjlib-util/include/pjlib-util/md5.h
+++ b/pjlib-util/include/pjlib-util/md5.h
@@ -38,9 +38,9 @@ PJ_BEGIN_DECL
/** MD5 context. */
typedef struct pj_md5_context
{
- pj_uint32_t buf[4];
- pj_uint32_t bits[2];
- pj_uint8_t in[64];
+ pj_uint32_t buf[4]; /**< buf */
+ pj_uint32_t bits[2]; /**< bits */
+ pj_uint8_t in[64]; /**< in */
} pj_md5_context;
/** Initialize the algorithm.
diff --git a/pjlib-util/include/pjlib-util/scanner_cis_uint.h b/pjlib-util/include/pjlib-util/scanner_cis_uint.h
index b44f8e66..99b06eb6 100644
--- a/pjlib-util/include/pjlib-util/scanner_cis_uint.h
+++ b/pjlib-util/include/pjlib-util/scanner_cis_uint.h
@@ -45,7 +45,7 @@ typedef int pj_cis_buf_t;
*/
typedef struct pj_cis_t
{
- PJ_CIS_ELEM_TYPE cis_buf[256];
+ PJ_CIS_ELEM_TYPE cis_buf[256]; /**< Internal buffer. */
} pj_cis_t;
diff --git a/pjlib-util/include/pjlib-util/sha1.h b/pjlib-util/include/pjlib-util/sha1.h
index 752c04bb..62b780ee 100644
--- a/pjlib-util/include/pjlib-util/sha1.h
+++ b/pjlib-util/include/pjlib-util/sha1.h
@@ -37,9 +37,9 @@ PJ_BEGIN_DECL
/** SHA1 context */
typedef struct pj_sha1_context
{
- pj_uint32_t state[5];
- pj_uint32_t count[2];
- pj_uint8_t buffer[64];
+ pj_uint32_t state[5]; /**< State */
+ pj_uint32_t count[2]; /**< Count */
+ pj_uint8_t buffer[64]; /**< Buffer */
} pj_sha1_context;
/** SHA1 digest size is 20 bytes */
diff --git a/pjlib-util/include/pjlib-util/srv_resolver.h b/pjlib-util/include/pjlib-util/srv_resolver.h
index be71025b..8fc9b598 100644
--- a/pjlib-util/include/pjlib-util/srv_resolver.h
+++ b/pjlib-util/include/pjlib-util/srv_resolver.h
@@ -32,7 +32,7 @@ PJ_BEGIN_DECL
* @ingroup PJ_DNS
* @{
*
- * \subsection PJ_DNS_SRV_RESOLVER_INTRO DNS SRV Resolution Helper
+ * \section PJ_DNS_SRV_RESOLVER_INTRO DNS SRV Resolution Helper
*
* This module provides an even higher layer of abstraction for the DNS
* resolution framework, to resolve DNS SRV names.
diff --git a/pjlib-util/include/pjlib-util/xml.h b/pjlib-util/include/pjlib-util/xml.h
index 1bfd7aa8..d00960dc 100644
--- a/pjlib-util/include/pjlib-util/xml.h
+++ b/pjlib-util/include/pjlib-util/xml.h
@@ -94,7 +94,7 @@ PJ_DECL(pj_xml_node*) pj_xml_parse( pj_pool_t *pool, char *msg, pj_size_t len);
* sufficient space in the buffer to print the message.
*/
PJ_DECL(int) pj_xml_print( const pj_xml_node *node, char *buf, pj_size_t len,
- pj_bool_t include_prolog);
+ pj_bool_t prolog);
/**
* Clone XML node and all subnodes.
@@ -123,7 +123,7 @@ PJ_DECL(pj_xml_node*) pj_xml_node_new(pj_pool_t *pool, const pj_str_t *name);
*
* @param pool Pool.
* @param name Attribute name.
- * @param attr Attribute value.
+ * @param value Attribute value.
*
* @return The new XML attribute.
*/
@@ -161,6 +161,7 @@ PJ_DECL(pj_xml_node*) pj_xml_find_node(pj_xml_node *parent, const pj_str_t *name
* Find first node with the specified name.
*
* @param parent Parent node.
+ * @param node node->next is the starting point.
* @param name Node name to find.
*
* @return XML node found or NULL.
@@ -184,7 +185,7 @@ PJ_DECL(pj_xml_attr*) pj_xml_find_attr(pj_xml_node *node, const pj_str_t *name,
/**
* Find a direct child node with the specified name and match the function.
*
- * @param node Parent node.
+ * @param parent Parent node.
* @param name Optional name.
* @param data Data to be passed to matching function.
* @param match Optional matching function.