From d583515e9daac73925c0cb1f617aa124666e5b34 Mon Sep 17 00:00:00 2001
From: Benny Prijono <bennylp@teluu.com>
Date: Fri, 25 Jan 2008 16:06:33 +0000
Subject: Fixed doxygen comments everywhere

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1748 74dad513-b988-da41-8d7b-12977e46ad98
---
 pjlib/include/pj/config.h  |  7 +++++--
 pjlib/include/pj/errno.h   | 15 +++++++++++++--
 pjlib/include/pj/ioqueue.h |  2 +-
 pjlib/include/pj/pool.h    |  1 +
 4 files changed, 20 insertions(+), 5 deletions(-)

(limited to 'pjlib/include')

diff --git a/pjlib/include/pj/config.h b/pjlib/include/pj/config.h
index 4a063bed..d620d4b7 100644
--- a/pjlib/include/pj/config.h
+++ b/pjlib/include/pj/config.h
@@ -449,7 +449,6 @@
 
 
 /**
- * \def PJ_HAS_TCP
  * Support TCP in the library.
  * Disabling TCP will reduce the footprint slightly (about 6KB).
  *
@@ -460,7 +459,6 @@
 #endif
 
 /**
- * \def PJ_HAS_IPV6
  * Support IPv6 in the library. If this support is disabled, some IPv6 
  * related functions will return PJ_EIPV6NOTSUP.
  *
@@ -845,6 +843,11 @@
  * @param type The return type of the function.
  * Declare a function that will not return.
  */
+/**
+ * @def PJ_IDECL_NO_RETURN(type)
+ * @param type The return type of the function.
+ * Declare an inline function that will not return.
+ */
 /**
  * @def PJ_BEGIN_DECL
  * Mark beginning of declaration section in a header file.
diff --git a/pjlib/include/pj/errno.h b/pjlib/include/pj/errno.h
index b838f069..57d90afe 100644
--- a/pjlib/include/pj/errno.h
+++ b/pjlib/include/pj/errno.h
@@ -111,7 +111,18 @@ PJ_DECL(void) pj_set_netos_error(pj_status_t code);
 PJ_DECL(pj_str_t) pj_strerror( pj_status_t statcode, 
 			       char *buf, pj_size_t bufsize);
 
-typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t);
+/**
+ * Type of callback to be specified in #pj_register_strerror()
+ *
+ * @param e	    The error code to lookup.
+ * @param msg	    Buffer to store the error message.
+ * @param max	    Length of the buffer.
+ *
+ * @return	    The error string.
+ */
+typedef pj_str_t (*pj_error_callback)(pj_status_t e, char *msg, pj_size_t max);
+
+
 /**
  * Register strerror message handler for the specified error space.
  * Application can register its own handler to supply the error message
@@ -133,7 +144,7 @@ typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t);
  */
 PJ_DECL(pj_status_t) pj_register_strerror(pj_status_t start_code,
 					  pj_status_t err_space,
-					  pjsip_error_callback f);
+					  pj_error_callback f);
 
 /**
  * @hideinitializer
diff --git a/pjlib/include/pj/ioqueue.h b/pjlib/include/pj/ioqueue.h
index 616ccc15..ded4aea1 100644
--- a/pjlib/include/pj/ioqueue.h
+++ b/pjlib/include/pj/ioqueue.h
@@ -166,7 +166,7 @@ typedef struct pj_ioqueue_callback
                              pj_ssize_t bytes_read);
 
     /**
-     * This callback is called when #pj_ioqueue_write or #pj_ioqueue_sendto
+     * This callback is called when #pj_ioqueue_send or #pj_ioqueue_sendto
      * completes.
      *
      * @param key	    The key.
diff --git a/pjlib/include/pj/pool.h b/pjlib/include/pj/pool.h
index d12076fd..42886408 100644
--- a/pjlib/include/pj/pool.h
+++ b/pjlib/include/pj/pool.h
@@ -612,6 +612,7 @@ typedef struct pj_pool_factory_policy
 } pj_pool_factory_policy;
 
 /**
+ * \def PJ_NO_MEMORY_EXCEPTION
  * This constant denotes the exception number that will be thrown by default
  * memory factory policy when memory allocation fails.
  *
-- 
cgit v1.2.3