stun: updated documentation

darcs-hash:20070920184522-65a35-964d47a220990b8d992d92222fe5039e28fcda01.gz

libsofia-sip-ua/stun/lookup_stun_server.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**
+/**@internal
  * @file lookup_stun_server.c 
  * @brief Test app for STUN DNS-SRV lookups.
  *

libsofia-sip-ua/stun/stun.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**
+/**@internal
  * @file stun.c STUN client module
  *
  * See RFC 3489/3489bis for further information.

libsofia-sip-ua/stun/stun.docs

@@ -14,9 +14,9 @@ client library.
 @section stun_contents Contents of stun Module
 
 The stun module contains the public header files as follows:
-- <stun.h>        the public API of the module
-- <stun_common.h> low-level functions for parsing and encoding STUN messages
-- <stun_tag.h>    defines the su tags used by stun
+- <sofia-sip/stun.h>        the public API of the module
+- <sofia-sip/stun_common.h> low-level functions for parsing and encoding STUN messages
+- <sofia-sip/stun_tag.h>    defines the su tags used by stun
 
 @section stun_usage Using Sofia STUN Library
 

libsofia-sip-ua/stun/stun_common.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**
+/**@internal
  * @file stun_common.c
  * @brief 
  * 

libsofia-sip-ua/stun/stun_dns.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**
+/**@internal
  * @file stun_dns.c 
  * @brief Functins to discover STUN server address using DNS-SRV.
  *

libsofia-sip-ua/stun/stun_mini.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**
+/**@internal
  * @file stun_mini.c
  * @brief Minimal stun server 
  * 

libsofia-sip-ua/stun/stun_tag.c

@@ -22,7 +22,7 @@
  *
  */
 
-/**@CFILE stun_tag.c  Tags and tag lists for Offer/Answer Engine
+/**@internal @CFILE stun_tag.c  Tags and tag lists for Offer/Answer Engine
  *
  * @author Pekka Pessi <Pekka.Pessi@nokia.com>
  * @author Martti Mela <Martti.Mela@nokia.com>