src/internet/model/ipv6-packet-info-tag.h
changeset 10405 45c8fceae24e
parent 10158 971f362648c3
--- a/src/internet/model/ipv6-packet-info-tag.h	Thu Nov 14 19:07:55 2013 +0100
+++ b/src/internet/model/ipv6-packet-info-tag.h	Thu Nov 14 22:43:53 2013 +0100
@@ -45,22 +45,70 @@
 {
 public:
   Ipv6PacketInfoTag ();
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Get the type ID.
+   * \return the object TypeId
+   */
+  static TypeId GetTypeId (void);
+
+  /**
+   * \brief Set the tag's address
+   *
+   * \param addr the address
+   */
   void SetAddress (Ipv6Address addr);
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Get the tag's address
+   *
+   * \returns the address
+   */
   Ipv6Address GetAddress (void) const;
+
+  /**
+   * \brief Set the tag's receiving interface
+   *
+   * \param ifindex the interface index
+   */
   void SetRecvIf (uint32_t ifindex);
+
+  /**
+   * \brief Get the tag's receiving interface
+   *
+   * \returns the interface index
+   */
   uint32_t GetRecvIf (void) const;
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Set the tag's Hop Limit
+   *
+   * \param ttl the hop limit
+   */
   void SetHoplimit (uint8_t ttl);
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Get the tag's Hop Limit
+   *
+   * \returns the Hop Limit
+   */
   uint8_t GetHoplimit (void) const;
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Set the tag's Traffic Class
+   *
+   * \param tclass the Traffic Class
+   */
   void SetTrafficClass (uint8_t tclass);
-  // Implemented, but not used in the stack yet
+
+  /**
+   * \brief Get the tag's Traffic Class
+   *
+   * \returns the Traffic Class
+   */
   uint8_t GetTrafficClass (void) const;
 
-  static TypeId GetTypeId (void);
+  // inherited functions, no doc necessary
   virtual TypeId GetInstanceTypeId (void) const;
   virtual uint32_t GetSerializedSize (void) const;
   virtual void Serialize (TagBuffer i) const;
@@ -83,10 +131,10 @@
    *  3.  the arriving hop limit, and
    *  4.  the arriving traffic class value.
   */
-  Ipv6Address m_addr;
-  uint8_t m_ifindex;
-  uint8_t m_hoplimit;
-  uint8_t m_tclass;
+  Ipv6Address m_addr;  //!< the packet address (src or dst)
+  uint8_t m_ifindex;   //!< the Interface index
+  uint8_t m_hoplimit;  //!< the Hop Limit
+  uint8_t m_tclass;    //!< the Traffic Class
 };
 } // namespace ns3