add doxygen
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Sat, 04 Aug 2007 16:52:01 +0200
changeset 1153 c33427a6bef0
parent 1152 1d06449f0a98
child 1154 3434ebc3c553
add doxygen
src/common/header.h
src/common/trailer.h
--- a/src/common/header.h	Sat Aug 04 16:49:06 2007 +0200
+++ b/src/common/header.h	Sat Aug 04 16:52:01 2007 +0200
@@ -24,6 +24,19 @@
 
 #include "chunk.h"
 
+/**
+ * \relates Header
+ * \brief this macro should be instantiated exactly once for each
+ *        new type of Header
+ *
+ * This macro will ensure that your new Header type is registered
+ * within the packet header registry. In most cases, this macro
+ * is not really needed but, for safety, please, use it all the
+ * time.
+ *
+ * Note: This macro is _absolutely_ needed if you try to run a
+ * distributed simulation.
+ */
 #define NS_HEADER_ENSURE_REGISTERED(x)          \
 namespace {                                     \
 static class thisisaveryverylongclassname       \
--- a/src/common/trailer.h	Sat Aug 04 16:49:06 2007 +0200
+++ b/src/common/trailer.h	Sat Aug 04 16:52:01 2007 +0200
@@ -24,6 +24,19 @@
 
 #include "chunk.h"
 
+/**
+ * \relates Trailer
+ * \brief this macro should be instantiated exactly once for each
+ *        new type of Trailer
+ *
+ * This macro will ensure that your new Trailer type is registered
+ * within the packet trailer registry. In most cases, this macro
+ * is not really needed but, for safety, please, use it all the
+ * time.
+ *
+ * Note: This macro is _absolutely_ needed if you try to run a
+ * distributed simulation.
+ */
 #define NS_TRAILER_ENSURE_REGISTERED(x)         \
 namespace {                                     \
 static class thisisaveryverylongclassname       \