From 71426c90f9ff0a3904de27ecaa4d04c9518965a0 Mon Sep 17 00:00:00 2001
From: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Date: Wed, 6 Sep 2006 15:01:56 +0200
Subject: [PATCH] fix documentation generation warning and add doc for
 TagPrettyPrinter

---
 src/common/tags.h | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/src/common/tags.h b/src/common/tags.h
index eee5807fd..6f9db0b8b 100644
--- a/src/common/tags.h
+++ b/src/common/tags.h
@@ -80,6 +80,8 @@ private:
 };
 
 /**
+ * \brief pretty print packet tags
+ * 
  * This class is used to register a pretty-printer
  * callback function to print in a nice user-friendly
  * way the content of the target type. To register
@@ -92,7 +94,11 @@ private:
 template <typename T>
 class TagPrettyPrinter {
 public:
-    TagPrettyPrinter<T> (void(*) (T *, std::ostream &));
+	/**
+	 * \param fn a function which can pretty-print an instance
+	 *        of type T in the output stream.
+	 */
+    TagPrettyPrinter<T> (void(*fn) (T *, std::ostream &));
 private:
     TagPrettyPrinter<T> ();
     static void prettyPrintCb (uint8_t *buf, std::ostream &os);
@@ -113,6 +119,10 @@ private:
 }; // namespace ns3
 
 
+
+/**************************************************************
+     An implementation of the templates defined above
+ *************************************************************/
 #include <cassert>
 #include <string.h>
 
@@ -161,13 +171,14 @@ const uint32_t TypeUid<T>::getUid (void)
 template <typename T>
 TagPrettyPrinter<T>::TagPrettyPrinter (void(*prettyPrinter) (T *, std::ostream &))
 {
+    assert (sizeof (T) <= Tags::SIZE);
     gPrettyPrinter  = prettyPrinter;
     TagsPrettyPrinterRegistry::record (TypeUid<T>::getUid (),
                       &TagPrettyPrinter<T>::prettyPrintCb);
 }
 template <typename T>
 void 
-TagPrettyPrinter<T>::prettyPrintCb (uint8_t buf[Tags::SIZE], std::ostream &os)
+TagPrettyPrinter<T>::prettyPrintCb (uint8_t *buf, std::ostream &os)
 {
     assert (sizeof (T) <= Tags::SIZE);
     T *tag = reinterpret_cast<T *> (buf);