From b5245c59aed4d568bc026083f10660e700f0f9db Mon Sep 17 00:00:00 2001
From: Tommaso Pecorella <tommaso.pecorella@unifi.it>
Date: Thu, 7 Apr 2016 00:33:40 +0200
Subject: [PATCH] traffic-control: doxygen fixes

---
 .../helper/traffic-control-helper.h            |  6 ++++++
 src/traffic-control/model/packet-filter.h      | 18 ++++++++++++++++--
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/src/traffic-control/helper/traffic-control-helper.h b/src/traffic-control/helper/traffic-control-helper.h
index 761463aa3..382871305 100644
--- a/src/traffic-control/helper/traffic-control-helper.h
+++ b/src/traffic-control/helper/traffic-control-helper.h
@@ -257,6 +257,9 @@ public:
                         std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
                         std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
 
+  /**
+   * Container type for Class IDs
+   */
   typedef std::vector<uint16_t> ClassIdList;
 
   /**
@@ -351,6 +354,9 @@ public:
                               std::string n14 = "", const AttributeValue &v14 = EmptyAttributeValue (),
                               std::string n15 = "", const AttributeValue &v15 = EmptyAttributeValue ());
 
+  /**
+   * Container type for Handlers
+   */
   typedef std::vector<uint16_t> HandleList;
 
   /**
diff --git a/src/traffic-control/model/packet-filter.h b/src/traffic-control/model/packet-filter.h
index d2fe75fa4..7d6313ec7 100644
--- a/src/traffic-control/model/packet-filter.h
+++ b/src/traffic-control/model/packet-filter.h
@@ -42,9 +42,16 @@ public:
   PacketFilter ();
   virtual ~PacketFilter ();
 
+  /**
+   * Standard value used by packet filters to indicate that no match was possible.
+   */
   static const int PF_NO_MATCH = -1;
 
   /**
+   * \brief Classify a packet.
+   *
+   * \param item the packet to classify.
+   *
    * \return -1 if this filter is not able to classify packets of the same protocol
    * as item or the item does not match the filter conditions, the configured return
    * value otherwise.
@@ -53,12 +60,19 @@ public:
 
 private:
   /**
-   * \return true if this filter is able to classify packets of the same protocol as item.
+   * \brief Checks if the filter is able to classify a kind of items.
+   *
+   * \param item an example item to check.
+   * \return true if this filter is able to classify packets.
    */
   virtual bool CheckProtocol (Ptr<QueueDiscItem> item) const = 0;
 
   /**
-   * \return -1 if the item does not match the filter conditions, the configured
+   * \brief Classify a packet.
+   *
+   * \param item the packet to classify.
+   *
+   * \return -1 if the item does not match the filter conditions, or the configured
    * return value otherwise.
    */
   virtual int32_t DoClassify (Ptr<QueueDiscItem> item) const = 0;