Updated doxygen documentations

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

6 files changed, 15 insertions, 8 deletions

diff --git a/pjnath/build/Makefile b/pjnath/build/Makefile
index 9292ba59..3322d73b 100644
--- a/pjnath/build/Makefile
+++ b/pjnath/build/Makefile
@@ -78,7 +78,11 @@ TARGETS := pjnath pjnath-test pjturn-client pjturn-srv
 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)/pjnath/docs/html.." ; \
+		cp -a ../docs/html/* $(WWWDIR)/pjnath/docs/html/ ; \
+	fi
 
 dep: depend
 distclean: realclean
diff --git a/pjnath/docs/UML-class-diagram.dia b/pjnath/docs/UML-class-diagram.dia
index ac9ffd3e..4e54231a 100644
--- a/pjnath/docs/UML-class-diagram.dia
+++ b/pjnath/docs/UML-class-diagram.dia
diff --git a/pjnath/docs/UML-class-diagram.png b/pjnath/docs/UML-class-diagram.png
index 49c68519..d3c08e9c 100644
--- a/pjnath/docs/UML-class-diagram.png
+++ b/pjnath/docs/UML-class-diagram.png
diff --git a/pjnath/docs/doxygen.cfg b/pjnath/docs/doxygen.cfg
index e769deb1..f7da72b2 100644
--- a/pjnath/docs/doxygen.cfg
+++ b/pjnath/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

@@ -870,12 +871,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 ../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       = ../pjnath/docs/pjnath.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 

@@ -887,12 +888,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/pjnath/docs/footer.html b/pjnath/docs/footer.html
index b2b7f567..a91856b4 100644
--- a/pjnath/docs/footer.html
+++ b/pjnath/docs/footer.html
@@ -1,7 +1,7 @@
 <p>&nbsp;</p>

 <hr><center>

 PJNATH - Open Source NAT traversal helper library supporting STUN, TURN, and ICE<br>

-(C)2001-2007 Benny Prijono

+(C)2001-2008 Benny Prijono

 </center>

 

 

diff --git a/pjnath/include/pjnath/stun_sock.h b/pjnath/include/pjnath/stun_sock.h
index a5ac7f69..248b5dcd 100644
--- a/pjnath/include/pjnath/stun_sock.h
+++ b/pjnath/include/pjnath/stun_sock.h
@@ -37,6 +37,7 @@ PJ_BEGIN_DECL
  * @brief STUN aware socket transport
  * @ingroup PJNATH_STUN
  * @{
+ *
  * The STUN transport provides asynchronous UDP like socket transport
  * with the additional capability to query the publicly mapped transport
  * address (using STUN resolution), to refresh the NAT binding, and to
@@ -128,13 +129,13 @@ typedef struct pj_stun_sock_cb
      *	  the STUN server, this callback will be called with \a op argument
      *    set to PJ_STUN_SOCK_BINDING_OP \a status  argument set to 
      *    PJ_SUCCESS.
-     *  - anytime when the transport has detected that the publicly mapped
+     *	- anytime when the transport has detected that the publicly mapped
      *    address has changed, this callback will be called with \a op
      *    argument set to PJ_STUN_SOCK_KEEP_ALIVE_OP and \a status
      *    argument set to PJ_SUCCESS. On this case and the case above,
      *    application will get the resolved public address in the
      *    #pj_stun_sock_info structure.
-     *  - for any terminal error (such as STUN time-out, DNS resolution
+     *	- for any terminal error (such as STUN time-out, DNS resolution
      *    failure, or keep-alive failure), this callback will be called 
      *	  with the \a status argument set to non-PJ_SUCCESS.
      *