From dcadef7fc04bb899333fb0ab472679c8ac280e09 Mon Sep 17 00:00:00 2001 From: Benny Prijono Date: Fri, 20 Jun 2008 21:39:02 +0000 Subject: Updated doxygen documentations git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@2037 74dad513-b988-da41-8d7b-12977e46ad98 --- pjlib-util/include/pjlib-util/config.h | 4 ++-- pjlib-util/include/pjlib-util/dns.h | 2 +- pjlib-util/include/pjlib-util/dns_server.h | 2 +- pjlib-util/include/pjlib-util/errno.h | 4 ++-- pjlib-util/include/pjlib-util/getopt.h | 2 +- pjlib-util/include/pjlib-util/pcap.h | 2 +- pjlib-util/include/pjlib-util/scanner.h | 2 +- pjlib-util/include/pjlib-util/string.h | 2 +- pjlib-util/include/pjlib-util/stun_simple.h | 2 +- pjlib-util/include/pjlib-util/types.h | 17 ++++++++++++++--- pjlib-util/include/pjlib-util/xml.h | 2 +- 11 files changed, 26 insertions(+), 15 deletions(-) (limited to 'pjlib-util/include') 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 /** - * @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 /** - * @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 Modules page for list - * of modules. + * Please go to the Table of Contents 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 * @{ */ -- cgit v1.2.3