summaryrefslogtreecommitdiff
path: root/pjlib-util
diff options
context:
space:
mode:
authorBenny Prijono <bennylp@teluu.com>2008-06-20 21:39:02 +0000
committerBenny Prijono <bennylp@teluu.com>2008-06-20 21:39:02 +0000
commitdcadef7fc04bb899333fb0ab472679c8ac280e09 (patch)
tree2338aea1588dac3380a1cbaf80b50a0a57dc3d80 /pjlib-util
parentf06496992c8bbc62f899e4ee782889a3a4b08a4e (diff)
Updated doxygen documentations
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@2037 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjlib-util')
-rw-r--r--pjlib-util/build/Makefile6
-rw-r--r--pjlib-util/docs/doxygen.cfg10
-rw-r--r--pjlib-util/docs/footer.html2
-rw-r--r--pjlib-util/include/pjlib-util/config.h4
-rw-r--r--pjlib-util/include/pjlib-util/dns.h2
-rw-r--r--pjlib-util/include/pjlib-util/dns_server.h2
-rw-r--r--pjlib-util/include/pjlib-util/errno.h4
-rw-r--r--pjlib-util/include/pjlib-util/getopt.h2
-rw-r--r--pjlib-util/include/pjlib-util/pcap.h2
-rw-r--r--pjlib-util/include/pjlib-util/scanner.h2
-rw-r--r--pjlib-util/include/pjlib-util/string.h2
-rw-r--r--pjlib-util/include/pjlib-util/stun_simple.h2
-rw-r--r--pjlib-util/include/pjlib-util/types.h17
-rw-r--r--pjlib-util/include/pjlib-util/xml.h2
14 files changed, 38 insertions, 21 deletions
diff --git a/pjlib-util/build/Makefile b/pjlib-util/build/Makefile
index c2977854..df735d4a 100644
--- a/pjlib-util/build/Makefile
+++ b/pjlib-util/build/Makefile
@@ -54,7 +54,11 @@ TARGETS := pjlib-util pjlib-util-test
all: $(TARGETS)
doc:
- cd .. && doxygen docs/doxygen.cfg
+ cd .. && rm -rf docs/html docs/latex && doxygen docs/doxygen.cfg
+ @if test ! "$(WWWDIR)" == ""; then \
+ echo "Copying to $(WWWDIR)/pjlib-util/docs/html.." ; \
+ cp -a ../docs/html/* $(WWWDIR)/pjlib-util/docs/html/ ; \
+ fi
dep: depend
distclean: realclean
diff --git a/pjlib-util/docs/doxygen.cfg b/pjlib-util/docs/doxygen.cfg
index 5790dd5d..1c2e15de 100644
--- a/pjlib-util/docs/doxygen.cfg
+++ b/pjlib-util/docs/doxygen.cfg
@@ -294,6 +294,7 @@ OPTIMIZE_OUTPUT_JAVA = NO
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
+TYPEDEF_HIDES_STRUCT = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
@@ -874,12 +875,12 @@ SKIP_FUNCTION_MACROS = YES
# The TAGFILES tag can be used to specify one or more tagfiles.
-TAGFILES =
+TAGFILES = ../pjlib/docs/pjlib.tag=../../../pjlib/docs/html ../pjnath/docs/pjnath.tag=../../../pjnath/docs/html ../pjsip/docs/pjsip.tag=../../../pjsip/docs/html ../pjmedia/docs/pjmedia.tag=../../../pjmedia/docs/html
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE =
+GENERATE_TAGFILE = docs/pjlib-util.tag
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
@@ -891,12 +892,13 @@ ALLEXTERNALS = NO
# in the modules index. If set to NO, only the current project's groups will
# be listed.
-EXTERNAL_GROUPS = YES
+EXTERNAL_GROUPS = NO
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
-PERL_PATH = /usr/bin/perl
+#PERL_PATH = /usr/bin/perl
+PERL_PATH = /c/Perl/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
diff --git a/pjlib-util/docs/footer.html b/pjlib-util/docs/footer.html
index 96c82062..e888b357 100644
--- a/pjlib-util/docs/footer.html
+++ b/pjlib-util/docs/footer.html
@@ -1,7 +1,7 @@
<p>&nbsp;</p>
<hr><center>
PJLIB-UTIL Open Source, small footprint, and portable asynchronous/caching DNS resolver, text scanner, STUN client, and XML library<br>
-(C)2001-2007 Benny Prijono
+(C)2001-2008 Benny Prijono
</center>
diff --git a/pjlib-util/include/pjlib-util/config.h b/pjlib-util/include/pjlib-util/config.h
index f01ade58..6393abe1 100644
--- a/pjlib-util/include/pjlib-util/config.h
+++ b/pjlib-util/include/pjlib-util/config.h
@@ -26,8 +26,8 @@
*/
/**
- * @defgroup PJLIB_UTIL_CONFIG PJLIB-UTIL Configuration
- * @ingroup PJLIB_UTIL
+ * @defgroup PJLIB_UTIL_CONFIG Configuration
+ * @ingroup PJLIB_UTIL_BASE
* @{
*/
diff --git a/pjlib-util/include/pjlib-util/dns.h b/pjlib-util/include/pjlib-util/dns.h
index a537169a..11ea4a6e 100644
--- a/pjlib-util/include/pjlib-util/dns.h
+++ b/pjlib-util/include/pjlib-util/dns.h
@@ -31,7 +31,7 @@ PJ_BEGIN_DECL
/**
* @defgroup PJ_DNS DNS and Asynchronous DNS Resolver
- * @ingroup PJLIB_UTIL
+ * @ingroup PJ_PROTOCOLS
*/
/**
diff --git a/pjlib-util/include/pjlib-util/dns_server.h b/pjlib-util/include/pjlib-util/dns_server.h
index 742b3c8e..3ff15f86 100644
--- a/pjlib-util/include/pjlib-util/dns_server.h
+++ b/pjlib-util/include/pjlib-util/dns_server.h
@@ -30,7 +30,7 @@ PJ_BEGIN_DECL
/**
* @defgroup PJ_DNS_SERVER Simple DNS Server
- * @ingroup PJLIB_UTIL
+ * @ingroup PJ_DNS
* @{
* This contains a simple but fully working DNS server implementation,
* mostly for testing purposes. It supports serving various DNS resource
diff --git a/pjlib-util/include/pjlib-util/errno.h b/pjlib-util/include/pjlib-util/errno.h
index 8db99f6a..8e098f1b 100644
--- a/pjlib-util/include/pjlib-util/errno.h
+++ b/pjlib-util/include/pjlib-util/errno.h
@@ -23,8 +23,8 @@
#include <pj/errno.h>
/**
- * @defgroup PJLIB_UTIL_ERROR PJLIB-UTIL Error Codes
- * @ingroup PJLIB_UTIL
+ * @defgroup PJLIB_UTIL_ERROR Error Codes
+ * @ingroup PJLIB_UTIL_BASE
* @{
*/
diff --git a/pjlib-util/include/pjlib-util/getopt.h b/pjlib-util/include/pjlib-util/getopt.h
index 4b48f9db..6c304d2e 100644
--- a/pjlib-util/include/pjlib-util/getopt.h
+++ b/pjlib-util/include/pjlib-util/getopt.h
@@ -29,7 +29,7 @@
/**
* @defgroup PJLIB_UTIL_GETOPT Getopt
- * @ingroup PJLIB_UTIL
+ * @ingroup PJLIB_TEXT
* @{
*/
diff --git a/pjlib-util/include/pjlib-util/pcap.h b/pjlib-util/include/pjlib-util/pcap.h
index 58d39a9f..492df0f3 100644
--- a/pjlib-util/include/pjlib-util/pcap.h
+++ b/pjlib-util/include/pjlib-util/pcap.h
@@ -30,7 +30,7 @@ PJ_BEGIN_DECL
/**
* @defgroup PJ_PCAP Simple PCAP file reader
- * @ingroup PJLIB_UTIL
+ * @ingroup PJ_FILE_FMT
* @{
* This module describes simple utility to read PCAP file. It is not intended
* to support all PCAP features (that's what libpcap is for!), but it can
diff --git a/pjlib-util/include/pjlib-util/scanner.h b/pjlib-util/include/pjlib-util/scanner.h
index 2460391f..d7bb8ff0 100644
--- a/pjlib-util/include/pjlib-util/scanner.h
+++ b/pjlib-util/include/pjlib-util/scanner.h
@@ -30,7 +30,7 @@ PJ_BEGIN_DECL
/**
* @defgroup PJ_SCAN Fast Text Scanning
- * @ingroup PJLIB_UTIL
+ * @ingroup PJLIB_TEXT
* @brief Text scanning utility.
*
* This module describes a fast text scanning functions.
diff --git a/pjlib-util/include/pjlib-util/string.h b/pjlib-util/include/pjlib-util/string.h
index 1ede956e..67763a74 100644
--- a/pjlib-util/include/pjlib-util/string.h
+++ b/pjlib-util/include/pjlib-util/string.h
@@ -29,7 +29,7 @@
/**
* @defgroup PJLIB_UTIL_STRING String Escaping Utilities
- * @ingroup PJLIB_UTIL
+ * @ingroup PJLIB_TEXT
* @{
*/
diff --git a/pjlib-util/include/pjlib-util/stun_simple.h b/pjlib-util/include/pjlib-util/stun_simple.h
index 02309082..3d456f56 100644
--- a/pjlib-util/include/pjlib-util/stun_simple.h
+++ b/pjlib-util/include/pjlib-util/stun_simple.h
@@ -144,7 +144,7 @@ PJ_DECL(void*) pjstun_msg_find_attr( pjstun_msg *msg, pjstun_attr_type t);
/**
* @defgroup PJLIB_UTIL_STUN_CLIENT Simple STUN Helper
- * @ingroup PJLIB_UTIL_STUN
+ * @ingroup PJ_PROTOCOLS
* @brief A simple and small footprint STUN resolution helper
* @{
*
diff --git a/pjlib-util/include/pjlib-util/types.h b/pjlib-util/include/pjlib-util/types.h
index a512f435..67764e5f 100644
--- a/pjlib-util/include/pjlib-util/types.h
+++ b/pjlib-util/include/pjlib-util/types.h
@@ -28,7 +28,7 @@
#include <pjlib-util/config.h>
/**
- * @defgroup PJLIB_UTIL PJLIB-UTIL Library
+ * @defgroup PJLIB_UTIL_BASE Base
* @{
*/
@@ -50,6 +50,17 @@ PJ_END_DECL
* @}
*/
+/**
+ * @defgroup PJLIB_TEXT Text and String Manipulation
+ */
+
+/**
+ * @defgroup PJ_PROTOCOLS Protocols
+ */
+
+/**
+ * @defgroup PJ_FILE_FMT File Formats
+ */
/**
* @mainpage PJLIB-UTIL
@@ -60,8 +71,8 @@ PJ_END_DECL
* This is the documentation of PJLIB-UTIL, an auxiliary library providing
* adjunct functions to PJLIB.
*
- * Please go to the <A HREF="modules.htm"><B>Modules</B></A> page for list
- * of modules.
+ * Please go to the <A HREF="modules.htm"><B>Table of Contents</B></A> page
+ * for list of modules.
*
*
* \n
diff --git a/pjlib-util/include/pjlib-util/xml.h b/pjlib-util/include/pjlib-util/xml.h
index d00960dc..10b9c0af 100644
--- a/pjlib-util/include/pjlib-util/xml.h
+++ b/pjlib-util/include/pjlib-util/xml.h
@@ -31,7 +31,7 @@ PJ_BEGIN_DECL
/**
* @defgroup PJ_TINY_XML Mini/Tiny XML Parser/Helper
- * @ingroup PJLIB_UTIL
+ * @ingroup PJ_FILE_FMT
* @{
*/