[sr-dev] git:master: doxygen: small bunch of fixes for doxygen documentation

Henning Westerholt henning.westerholt at 1und1.de
Fri Jun 24 00:36:47 CEST 2011


Module: sip-router
Branch: master
Commit: ee47cfb6029ecc1d2340a3f90496de17e534d505
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ee47cfb6029ecc1d2340a3f90496de17e534d505

Author: Henning Westerholt <henning.westerholt at 1und1.de>
Committer: Henning Westerholt <henning.westerholt at 1und1.de>
Date:   Fri Jun 24 00:36:18 2011 +0200

doxygen: small bunch of fixes for doxygen documentation

---

 atomic_ops.h |    2 +-
 cfg_parser.h |    2 +-
 md5.c        |    9 ++++-----
 md5.h        |    7 +++++++
 4 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/atomic_ops.h b/atomic_ops.h
index 7b0d1f8..c2c0249 100644
--- a/atomic_ops.h
+++ b/atomic_ops.h
@@ -21,7 +21,7 @@
  * \brief SIP-router core :: Atomic operations and memory barriers
  * \ingroup core
  * Module: \ref core
- * See \ref atomicops
+ * See \ref atomic
  */
 
 /*
diff --git a/cfg_parser.h b/cfg_parser.h
index 11296c5..8240d22 100644
--- a/cfg_parser.h
+++ b/cfg_parser.h
@@ -163,7 +163,7 @@ void cfg_parser_close(struct cfg_parser* st);
 
 struct cfg_option* cfg_lookup_token(struct cfg_option* options, str* token);
 
-/*! ! \briefInterface to the lexical scanner */
+/*! ! \brief Interface to the lexical scanner */
 int cfg_get_token(struct cfg_token* token, struct cfg_parser* st, unsigned int flags);
 
 /* Commonly needed parser functions */
diff --git a/md5.c b/md5.c
index 1c628df..ab011da 100644
--- a/md5.c
+++ b/md5.c
@@ -35,7 +35,7 @@
 
 
 /**
- * \brief Constants for MD5Transform routine.
+ * \name Constants for MD5Transform routine
  */
 
 /*@{ */
@@ -70,7 +70,7 @@ static unsigned char PADDING[64] = {
 };
 
 /**
- * \brief F, G, H and I are basic MD5 functions.
+ * \name F, G, H and I are basic MD5 functions
  */
 
 /*@{ */
@@ -81,13 +81,12 @@ static unsigned char PADDING[64] = {
 /*@} */
 
 /**
- * \brief ROTATE_LEFT rotates x left n bits.
+ * \brief ROTATE_LEFT rotates x left n bits
  */
 #define ROTATE_LEFT(x, n) (((x) << (n)) | ((x) >> (32-(n))))
 
 /**
- * \brief FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4.
- * 
+ * \name FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4
  * FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4.
  * Rotation is separate from addition to prevent recomputation.
  */
diff --git a/md5.h b/md5.h
index 756a96e..d4fa2de 100644
--- a/md5.h
+++ b/md5.h
@@ -21,6 +21,13 @@
  * documentation and/or software.
  */
 
+/*!
+ * \file
+ * \brief SIP-router core :: md5 hash support
+ * \ingroup core
+ * Module: \ref core
+ */
+
 #ifndef MD5_H
 #define MD5_H
 




More information about the sr-dev mailing list