Updated doxygen documentations

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@2037 74dad513-b988-da41-8d7b-12977e46ad98

10 files changed, 12 insertions, 17 deletions

diff --git a/pjsip/build/Makefile b/pjsip/build/Makefile
index 8d746f01..ef78f420 100644
--- a/pjsip/build/Makefile
+++ b/pjsip/build/Makefile
@@ -109,7 +109,11 @@ TARGETS := pjsip pjsip-ua pjsip-simple pjsua-lib pjsip-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)/pjsip/docs/html.." ; \
+		cp -a ../docs/html/* $(WWWDIR)/pjsip/docs/html/ ; \
+	fi
 
 dep: depend
 distclean: realclean
diff --git a/pjsip/docs/doxygen.cfg b/pjsip/docs/doxygen.cfg
index 1c5aad49..fc87325d 100644
--- a/pjsip/docs/doxygen.cfg
+++ b/pjsip/docs/doxygen.cfg
@@ -295,6 +295,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

@@ -869,12 +870,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 ../pjlib-util/docs/pjlib-util.tag=../../../pjlib-util/docs/html ../pjnath/docs/pjnath.tag=../../../pjnath/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/pjsip.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 

@@ -886,12 +887,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/pjsip/docs/footer.html b/pjsip/docs/footer.html
index 9ee1ac28..0b6d806a 100644
--- a/pjsip/docs/footer.html
+++ b/pjsip/docs/footer.html
@@ -1,7 +1,7 @@
 <p>&nbsp;</p>

 <hr><center>

 PJSIP Open Source, high performance, small footprint, and very very portable SIP stack<br>

-(C)2003-2007 Benny Prijono

+(C)2003-2008 Benny Prijono

 </center>

 <!--#include virtual="/footer.html" -->

 

diff --git a/pjsip/include/pjsip-ua/sip_inv.h b/pjsip/include/pjsip-ua/sip_inv.h
index 448718dd..96c6824c 100644
--- a/pjsip/include/pjsip-ua/sip_inv.h
+++ b/pjsip/include/pjsip-ua/sip_inv.h
@@ -31,7 +31,6 @@
 
 /**
  * @defgroup PJSIP_HIGH_UA User Agent Library
- * @ingroup PJSIP
  * @brief Mid-level User Agent Library.
  *
  * This is the high level user agent library, which consists of:
diff --git a/pjsip/include/pjsip/sip_config.h b/pjsip/include/pjsip/sip_config.h
index a63e2250..4ef2ce61 100644
--- a/pjsip/include/pjsip/sip_config.h
+++ b/pjsip/include/pjsip/sip_config.h
@@ -26,12 +26,7 @@
 #include <pj/types.h>
 
 /**
- * @defgroup PJSIP PJSIP Library Collection
- */
-
-/**
  * @defgroup PJSIP_CORE Core SIP Library
- * @ingroup PJSIP
  * @brief The core framework from which all other SIP components depends on.
  * 
  * The PJSIP Core library only provides transport framework, event
diff --git a/pjsip/include/pjsip/sip_transaction.h b/pjsip/include/pjsip/sip_transaction.h
index 2865b6e1..a5863da3 100644
--- a/pjsip/include/pjsip/sip_transaction.h
+++ b/pjsip/include/pjsip/sip_transaction.h
@@ -33,7 +33,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJSIP_TRANSACT Transaction Layer
- * @ingroup PJSIP
  * @brief Provides statefull message processing.
  *
  * This module provides stateful processing to incoming or outgoing SIP
diff --git a/pjsip/include/pjsip/sip_ua_layer.h b/pjsip/include/pjsip/sip_ua_layer.h
index 19852777..56029bda 100644
--- a/pjsip/include/pjsip/sip_ua_layer.h
+++ b/pjsip/include/pjsip/sip_ua_layer.h
@@ -30,7 +30,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJSIP_UA Base User Agent Layer/Common Dialog Layer
- * @ingroup PJSIP
  * @brief Dialog management.
  *
  * This module provides basic dialog management, which is used by higher
diff --git a/pjsip/include/pjsip/sip_util.h b/pjsip/include/pjsip/sip_util.h
index 92264be6..32b6860d 100644
--- a/pjsip/include/pjsip/sip_util.h
+++ b/pjsip/include/pjsip/sip_util.h
@@ -582,7 +582,6 @@ PJ_DECL(pj_status_t) pjsip_endpt_send_request( pjsip_endpoint *endpt,
 
 /**
  * @defgroup PJSIP_PROXY_CORE Core Proxy Layer
- * @ingroup PJSIP
  * @brief Core proxy operations
  * @{
  */
diff --git a/pjsip/include/pjsip_simple.h b/pjsip/include/pjsip_simple.h
index d81f0515..8dd4e6b3 100644
--- a/pjsip/include/pjsip_simple.h
+++ b/pjsip/include/pjsip_simple.h
@@ -19,7 +19,6 @@
 
 /**
  * @defgroup PJSIP_SIMPLE Event and Presence Framework
- * @ingroup PJSIP
  */
 
 /**
diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h
index 0ee97f9c..65ccf307 100644
--- a/pjsip/include/pjsua-lib/pjsua.h
+++ b/pjsip/include/pjsua-lib/pjsua.h
@@ -55,7 +55,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJSUA_LIB PJSUA API - High Level Softphone API for C/C++ and Python
- * @ingroup PJSIP
  * @brief Very high level API for constructing SIP UA applications.
  * @{
  *