# HG changeset patch
# User Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
# Date 1186239121 -7200
# Node ID c33427a6bef05e3c22b34202018c004be4cefcde
# Parent  1d06449f0a98ed2fecb014edbd1ef05bf07b078e
add doxygen

diff -r 1d06449f0a98 -r c33427a6bef0 src/common/header.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       \
diff -r 1d06449f0a98 -r c33427a6bef0 src/common/trailer.h
--- 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       \