Updated doxygen documentations

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

12 files changed, 10 insertions, 19 deletions

diff --git a/pjlib/build/Makefile b/pjlib/build/Makefile
index 68a0c0e6..4d747e10 100644
--- a/pjlib/build/Makefile
+++ b/pjlib/build/Makefile
@@ -55,7 +55,11 @@ export CC_OUT CC AR RANLIB HOST_MV HOST_RM HOST_RMDIR HOST_MKDIR OBJEXT LD LDOUT
 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/docs/html.." ; \
+		cp -a ../docs/html/* $(WWWDIR)/pjlib/docs/html/ ; \
+	fi
 
 print:
 	$(MAKE) -f $(RULES_MAK) APP=PJLIB app=pjlib print_lib
diff --git a/pjlib/docs/doxygen.cfg b/pjlib/docs/doxygen.cfg
index e6b0d754..6b6a8d3e 100644
--- a/pjlib/docs/doxygen.cfg
+++ b/pjlib/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

@@ -878,7 +879,7 @@ TAGFILES               =
 # 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.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 

@@ -895,7 +896,8 @@ EXTERNAL_GROUPS        = YES
 # 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/docs/footer.html b/pjlib/docs/footer.html
index 7c7bc4a5..6eea5a91 100644
--- a/pjlib/docs/footer.html
+++ b/pjlib/docs/footer.html
@@ -1,7 +1,7 @@
 <p>&nbsp;</p>

 <hr><center>

 PJLIB Open Source, high performance, small footprint, and very very portable framework<br>

-(C)2001-2007 Benny Prijono

+(C)2001-2008 Benny Prijono

 </center>

 

 

diff --git a/pjlib/include/pj/config.h b/pjlib/include/pj/config.h
index 22564420..fe182e38 100644
--- a/pjlib/include/pj/config.h
+++ b/pjlib/include/pj/config.h
@@ -303,7 +303,6 @@
 
 /**
  * @defgroup pj_config Build Configuration
- * @ingroup PJ
  * @{
  *
  * This section contains macros that can set during PJLIB build process
@@ -804,7 +803,6 @@
 
 /**
  * @defgroup pj_config Build Configuration
- * @ingroup PJ
  * @{
  */
 
diff --git a/pjlib/include/pj/doxygen.h b/pjlib/include/pj/doxygen.h
index 5a6ece2c..ee88ea17 100644
--- a/pjlib/include/pj/doxygen.h
+++ b/pjlib/include/pj/doxygen.h
@@ -53,10 +53,6 @@
  * \a doxygen (http://www.doxygen.org). Doxygen is a great (and free!) 
  * tools for generating such documentation.
  *
- * @subsection doc_ver_subsec Version
- *
- * This document corresponds to PJLIB version 0.8.0.
- *
  *
  * @subsection find_samples_subsec How to Read This Document
  *
diff --git a/pjlib/include/pj/errno.h b/pjlib/include/pj/errno.h
index 57d90afe..b72092df 100644
--- a/pjlib/include/pj/errno.h
+++ b/pjlib/include/pj/errno.h
@@ -30,7 +30,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup pj_errno Error Codes
- * @ingroup PJ
  * @{
  *
  * In PJLIB, error/status codes from operating system are translated
diff --git a/pjlib/include/pj/guid.h b/pjlib/include/pj/guid.h
index 5ce1adf0..0d89a934 100644
--- a/pjlib/include/pj/guid.h
+++ b/pjlib/include/pj/guid.h
@@ -32,7 +32,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJ_DS Data Structure.
- * @ingroup PJ
  */
 /**
  * @defgroup PJ_GUID Globally Unique Identifier
diff --git a/pjlib/include/pj/list.h b/pjlib/include/pj/list.h
index f6f2c167..6320f56f 100644
--- a/pjlib/include/pj/list.h
+++ b/pjlib/include/pj/list.h
@@ -30,7 +30,6 @@ PJ_BEGIN_DECL
 
 /*
  * @defgroup PJ_DS Data Structure.
- * @ingroup PJ
  */
 
 /**
diff --git a/pjlib/include/pj/log.h b/pjlib/include/pj/log.h
index 0870708e..763b5943 100644
--- a/pjlib/include/pj/log.h
+++ b/pjlib/include/pj/log.h
@@ -31,7 +31,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJ_MISC Miscelaneous
- * @ingroup PJ
  */
 
 /**
diff --git a/pjlib/include/pj/os.h b/pjlib/include/pj/os.h
index f5503c98..f99aa6bb 100644
--- a/pjlib/include/pj/os.h
+++ b/pjlib/include/pj/os.h
@@ -29,7 +29,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJ_OS Operating System Dependent Functionality.
- * @ingroup PJ
  */
 
 
diff --git a/pjlib/include/pj/pool.h b/pjlib/include/pj/pool.h
index 42886408..35d8b3f4 100644
--- a/pjlib/include/pj/pool.h
+++ b/pjlib/include/pj/pool.h
@@ -39,7 +39,6 @@ PJ_BEGIN_DECL
 
 /**
  * @defgroup PJ_POOL_GROUP Fast Memory Pool
- * @ingroup PJ
  * @brief
  * Memory pools allow dynamic memory allocation comparable to malloc or the 
  * new in operator C++. Those implementations are not desirable for very
diff --git a/pjlib/include/pj/types.h b/pjlib/include/pj/types.h
index 4ea5b79b..d792fdd5 100644
--- a/pjlib/include/pj/types.h
+++ b/pjlib/include/pj/types.h
@@ -21,9 +21,6 @@
 
 
 /**
- * @defgroup PJ PJ Library
- */
-/**
  * @file types.h
  * @brief Declaration of basic types and utility.
  */