Fix up some doxygen issues.

(closes issue #11996)
Patches:
      bug_11996_doxygen.diff uploaded by snuffy (license 35)


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@103723 f38db490-d61c-443f-a65b-d21fe96a405b

8 files changed, 34 insertions, 33 deletions

diff --git a/channels/chan_sip.c b/channels/chan_sip.c
index ea05c88fd..55f63d2d2 100644
--- a/channels/chan_sip.c
+++ b/channels/chan_sip.c
@@ -360,7 +360,7 @@ enum check_auth_result {
 /*! \brief States for outbound registrations (with register= lines in sip.conf */
 enum sipregistrystate {
 	REG_STATE_UNREGISTERED = 0,	/*!< We are not registred 
-		 *  \noteInitial state. We should have a timeout scheduled for the initial
+		 *  \note Initial state. We should have a timeout scheduled for the initial
 		 * (or next) registration transmission, calling sip_reregister
 		 */
 
@@ -580,7 +580,7 @@ static const struct cfsip_options {
 /*! \brief Standard SIP and TLS port from RFC 3261. DO NOT CHANGE THIS */
 #define STANDARD_SIP_PORT	5060
 #define STANDARD_TLS_PORT	5061
-/* Note: in many SIP headers, absence of a port number implies port 5060,
+/*! \note in many SIP headers, absence of a port number implies port 5060,
  * and this is why we cannot change the above constant.
  * There is a limited number of places in asterisk where we could,
  * in principle, use a different "default" port number, but
@@ -724,8 +724,8 @@ static int global_max_se;                     /*!< Highest threshold for session
 
 /*@}*/ 
 
-/*! Object counters @{ 
- * \bug These counters are not handled in a thread-safe way.  ast_atomic_fetchadd_int()
+/*! \name Object counters @{
+ * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
  * should be used to modify these values. */
 static int suserobjs = 0;                /*!< Static users */
 static int ruserobjs = 0;                /*!< Realtime users */
@@ -1671,8 +1671,8 @@ enum t38_action_flag {
 };
 
 /*---------------------------- Forward declarations of functions in chan_sip.c */
-/*! \note This is added to help splitting up chan_sip.c into several files
-	in coming releases */
+/* Note: This is added to help splitting up chan_sip.c into several files
+	in coming releases. */
 
 /*--- PBX interface functions */
 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
@@ -18477,7 +18477,8 @@ static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp)
 
 
 /*! \brief Get Max or Min SE (session timer expiry)
-	\param max if true, get max se, otherwise min se
+ * \param p pointer to the SIP dialog 
+ * \param max if true, get max se, otherwise min se
 */
 int st_get_se(struct sip_pvt *p, int max)
 {
@@ -18528,7 +18529,7 @@ int st_get_se(struct sip_pvt *p, int max)
 
 
 /*! \brief Get the entity (UAC or UAS) that's acting as the session-timer refresher 
-	\param sip_pvt pointer to the SIP dialog 
+ * \param p pointer to the SIP dialog 
 */
 enum st_refresher st_get_refresher(struct sip_pvt *p)
 {
@@ -18557,7 +18558,7 @@ enum st_refresher st_get_refresher(struct sip_pvt *p)
 
 
 /*! \brief Get the session-timer mode 
-	\param sip_pvt pointer to the SIP dialog 
+ * \param p pointer to the SIP dialog 
 */
 enum st_mode st_get_mode(struct sip_pvt *p)
 {
@@ -18769,12 +18770,14 @@ static int sip_devicestate(void *data)
 }
 
 /*! \brief PBX interface function -build SIP pvt structure 
-	SIP calls initiated by the PBX arrive here 
-
-	SIP Dial string syntax
-		SIP/exten@host!dnid
-	or	SIP/host/exten!dnid
-	or	SIP/host!dnid
+ *	SIP calls initiated by the PBX arrive here. 
+ *
+ * \verbatim	
+ * 	SIP Dial string syntax
+ *		SIP/exten@host!dnid
+ *	or	SIP/host/exten!dnid
+ *	or	SIP/host!dnid
+ * \endverbatim
 */
 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause)
 {
diff --git a/channels/chan_zap.c b/channels/chan_zap.c
index 58516e73b..d7676b359 100644
--- a/channels/chan_zap.c
+++ b/channels/chan_zap.c
@@ -6041,15 +6041,14 @@ static int zt_wink(struct zt_pvt *p, int index)
 	return 0;
 }
 
-/*! enable or disable the chan_zap Do-Not-Disturb mode for a Zaptel channel
- * @zapchan "Physical" Zaptel channel (e.g: Zap/5)
- * @on: 1 to enable, 0 to disable
+/*! \brief enable or disable the chan_zap Do-Not-Disturb mode for a Zaptel channel
+ * \param zapchan "Physical" Zaptel channel (e.g: Zap/5)
+ * \param on 1 to enable, 0 to disable
  *
  * chan_zap has a DND (Do Not Disturb) mode for each zapchan (physical 
  * zaptel channel). Use this to enable or disable it.
  *
- * \fixme the use of the word "channel" for those zapchans is really
- * confusing.
+ * \bug the use of the word "channel" for those zapchans is really confusing.
  */
 static void zap_dnd(struct zt_pvt *zapchan, int on)
 {
diff --git a/channels/misdn/chan_misdn_config.h b/channels/misdn/chan_misdn_config.h
index 8c27f4f24..06e234783 100644
--- a/channels/misdn/chan_misdn_config.h
+++ b/channels/misdn/chan_misdn_config.h
@@ -11,8 +11,8 @@
  * the GNU General Public License
  */
 
-/*! \file \brief
- * Interface to mISDN - Config
+/*! \file 
+ * \brief Interface to mISDN - Config
  * \author Christian Richter <crich@beronet.com>
  */
 
diff --git a/channels/misdn/ie.c b/channels/misdn/ie.c
index 817e3d8cb..fbd06d163 100644
--- a/channels/misdn/ie.c
+++ b/channels/misdn/ie.c
@@ -15,8 +15,8 @@
  * the GNU General Public License
  */
 
-/*! \file \brief
- * Interface to mISDN
+/*! \file 
+ * \brief Interface to mISDN
  * \author Christian Richter <crich@beronet.com>
  */
 
diff --git a/channels/misdn/isdn_lib.c b/channels/misdn/isdn_lib.c
index 67ecb47fa..b951e2ea8 100644
--- a/channels/misdn/isdn_lib.c
+++ b/channels/misdn/isdn_lib.c
@@ -11,8 +11,8 @@
  * the GNU General Public License
  */
 
-/*! \file \brief
- * Interface to mISDN
+/*! \file 
+ * \brief Interface to mISDN
  * \author Christian Richter <crich@beronet.com>
  */
 
diff --git a/channels/misdn/isdn_lib.h b/channels/misdn/isdn_lib.h
index 731d497b3..85922c630 100644
--- a/channels/misdn/isdn_lib.h
+++ b/channels/misdn/isdn_lib.h
@@ -11,9 +11,8 @@
  * the GNU General Public License
  */
 
-/*! \file \brief
- * 
- * Interface to mISDN
+/*! \file 
+ * \brief Interface to mISDN
  *
  * \author Christian Richter <crich@beronet.com>
  */
diff --git a/channels/misdn/isdn_msg_parser.c b/channels/misdn/isdn_msg_parser.c
index ebaf6a92f..dc2f74e9d 100644
--- a/channels/misdn/isdn_msg_parser.c
+++ b/channels/misdn/isdn_msg_parser.c
@@ -11,8 +11,8 @@
  * the GNU General Public License
  */
 
-/*! \file \brief
- * Interface to mISDN - message parser
+/*! \file 
+ * \brief Interface to mISDN - message parser
  * \author Christian Richter <crich@beronet.com>
  */
 
diff --git a/channels/misdn/portinfo.c b/channels/misdn/portinfo.c
index 8223164e5..6d5f2154d 100644
--- a/channels/misdn/portinfo.c
+++ b/channels/misdn/portinfo.c
@@ -1,5 +1,5 @@
-/*! \file \brief
- * Interface to mISDN - ???
+/*! \file 
+ * \brief Interface to mISDN - port info
  * \author Christian Richter <crich@beronet.com>
  */