add Constants section to doxygen documentation
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 25 Sep 2006 18:55:23 +0200
changeset 94 6aabc116c7c7
parent 93 6318b8cbf212
child 95 deaf3193d9dc
add Constants section to doxygen documentation
doc/main.txt
src/common/tags.h
--- a/doc/main.txt	Fri Sep 15 13:05:03 2006 +0200
+++ b/doc/main.txt	Mon Sep 25 18:55:23 2006 +0200
@@ -33,3 +33,7 @@
  * \brief Every class exported by the ns3 library is enclosed in the
  * ns3 namespace.
  */
+/**
+ * \defgroup constants
+ * \brief Constants you can change
+ */
\ No newline at end of file
--- a/src/common/tags.h	Fri Sep 15 13:05:03 2006 +0200
+++ b/src/common/tags.h	Mon Sep 25 18:55:23 2006 +0200
@@ -30,6 +30,14 @@
 template <typename T>
 class TagPrettyPrinter;
 
+/**
+ * \ingroup constants
+ * \brief Tag maximum size
+ * The maximum size (in bytes) of a Tag is stored
+ * in this constant.
+ */
+#define TAGS_MAX_SIZE 16
+
 class Tags {
 public:
     inline Tags ();
@@ -51,7 +59,7 @@
     inline void removeAll (void);
 
     enum {
-        SIZE = 16
+        SIZE = TAGS_MAX_SIZE
     };
 private:
     struct TagData {