Fix doxygen errors in src/network, excluding 'is not documented' missing documentation
authorVedran Miletić <rivanvx@gmail.com>
Mon, 02 Dec 2013 23:02:39 +0100
changeset 10458 20987b07dbd4
parent 10457 299e2483e596
child 10459 f2e90c12a44f
Fix doxygen errors in src/network, excluding 'is not documented' missing documentation
src/network/helper/trace-helper.h
src/network/model/byte-tag-list.h
src/network/model/packet-tag-list.h
src/network/utils/ascii-file.h
src/network/utils/error-model.h
src/network/utils/red-queue.h
--- a/src/network/helper/trace-helper.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/helper/trace-helper.h	Mon Dec 02 23:02:39 2013 +0100
@@ -67,23 +67,42 @@
   /**
    * @brief Let the pcap helper figure out a reasonable filename to use for a
    * pcap file associated with a device.
+   * 
+   * @param prefix prefix string
+   * @param device NetDevice
+   * @param useObjectNames use node and device names instead of indexes
    */
   std::string GetFilenameFromDevice (std::string prefix, Ptr<NetDevice> device, bool useObjectNames = true);
 
   /**
    * @brief Let the pcap helper figure out a reasonable filename to use for the
    * pcap file associated with a node.
+   * 
+   * @param prefix prefix string
+   * @param object interface (such as Ipv4Interface or Ipv6Interface)
+   * @param interface interface id
+   * @param useObjectNames use node and device names instead of indexes
    */
   std::string GetFilenameFromInterfacePair (std::string prefix, Ptr<Object> object, 
                                             uint32_t interface, bool useObjectNames = true);
 
   /**
    * @brief Create and initialize a pcap file.
+   * 
+   * @param filename file name
+   * @param filemode file mode
+   * @param dataLinkType data link type of packet data
+   * @param snapLen maximum length of packet data stored in records
+   * @param tzCorrection time zone correction to be applied to timestamps of packets
    */
   Ptr<PcapFileWrapper> CreateFile (std::string filename, std::ios::openmode filemode,
                                    uint32_t dataLinkType,  uint32_t snapLen = 65535, int32_t tzCorrection = 0);
   /**
    * @brief Hook a trace source to the default trace sink
+   * 
+   * @param object object
+   * @param traceName trace source name
+   * @param file file wrapper
    */
   template <typename T> void HookDefaultSink (Ptr<T> object, std::string traceName, Ptr<PcapFileWrapper> file);
 
@@ -122,12 +141,21 @@
   /**
    * @brief Let the ascii trace helper figure out a reasonable filename to use
    * for an ascii trace file associated with a device.
+   * 
+   * @param prefix prefix string
+   * @param device NetDevice
+   * @param useObjectNames use node and device names instead of indexes
    */
   std::string GetFilenameFromDevice (std::string prefix, Ptr<NetDevice> device, bool useObjectNames = true);
 
   /**
    * @brief Let the ascii trace helper figure out a reasonable filename to use
    * for an ascii trace file associated with a node.
+   * 
+   * @param prefix prefix string
+   * @param object interface (such as Ipv4Interface or Ipv6Interface)
+   * @param interface interface id
+   * @param useObjectNames use node and device names instead of indexes
    */
   std::string GetFilenameFromInterfacePair (std::string prefix, Ptr<Object> object, 
                                             uint32_t interface, bool useObjectNames = true);
@@ -151,6 +179,9 @@
    * run into object lifetime issues.  Ns-3 has a nice reference counted object
    * that can solve the problem so we use one of those to carry the stream
    * around and deal with the lifetime issues.
+   * 
+   * @param filename file name
+   * @param filemode file mode
    */
   Ptr<OutputStreamWrapper> CreateFileStream (std::string filename, 
                                              std::ios::openmode filemode = std::ios::out);
@@ -158,6 +189,10 @@
   /**
    * @brief Hook a trace source to the default enqueue operation trace sink that
    * does not accept nor log a trace context.
+   * 
+   * @param object object
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultEnqueueSinkWithoutContext (Ptr<T> object, std::string traceName, Ptr<OutputStreamWrapper> stream);
@@ -165,6 +200,11 @@
   /**
    * @brief Hook a trace source to the default enqueue operation trace sink that
    * does accept and log a trace context.
+   * 
+   * @param object object
+   * @param context context string
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultEnqueueSinkWithContext (Ptr<T> object, 
@@ -173,6 +213,10 @@
   /**
    * @brief Hook a trace source to the default drop operation trace sink that 
    * does not accept nor log a trace context.
+   * 
+   * @param object object
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultDropSinkWithoutContext (Ptr<T> object, std::string traceName, Ptr<OutputStreamWrapper> stream);
@@ -180,6 +224,11 @@
   /**
    * @brief Hook a trace source to the default drop operation trace sink that 
    * does accept and log a trace context.
+   * 
+   * @param object object
+   * @param context context string
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultDropSinkWithContext (Ptr<T> object, 
@@ -188,6 +237,10 @@
   /**
    * @brief Hook a trace source to the default dequeue operation trace sink
    * that does not accept nor log a trace context.
+   * 
+   * @param object object
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultDequeueSinkWithoutContext (Ptr<T> object, std::string traceName, Ptr<OutputStreamWrapper> stream);
@@ -195,6 +248,11 @@
   /**
    * @brief Hook a trace source to the default dequeue operation trace sink
    * that does accept and log a trace context.
+   * 
+   * @param object object
+   * @param context context string
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultDequeueSinkWithContext (Ptr<T> object, 
@@ -203,6 +261,10 @@
   /**
    * @brief Hook a trace source to the default receive operation trace sink
    * that does not accept nor log a trace context.
+   * 
+   * @param object object
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultReceiveSinkWithoutContext (Ptr<T> object, std::string traceName, Ptr<OutputStreamWrapper> stream);
@@ -210,6 +272,11 @@
   /**
    * @brief Hook a trace source to the default receive operation trace sink
    * that does accept and log a trace context.
+   * 
+   * @param object object
+   * @param context context string
+   * @param traceName trace source name
+   * @param stream output stream wrapper
    */
   template <typename T> 
   void HookDefaultReceiveSinkWithContext (Ptr<T> object, 
--- a/src/network/model/byte-tag-list.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/model/byte-tag-list.h	Mon Dec 02 23:02:39 2013 +0100
@@ -136,7 +136,7 @@
    * 
    * Copy constructor, copies the data and increases reference count
    *
-   * \param The ByteTagList to copy
+   * \param o The ByteTagList to copy
    * \returns The newly created ByteTagList
    *
    */
--- a/src/network/model/packet-tag-list.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/model/packet-tag-list.h	Mon Dec 02 23:02:39 2013 +0100
@@ -177,7 +177,7 @@
    * \param [in] o The PacketTagList to copy.
    *
    * This makes a light-weight copy by #RemoveAll, then
-   * pointing to the same #struct TagData as \pname{o}.
+   * pointing to the same \ref TagData as \pname{o}.
    */
   inline PacketTagList (PacketTagList const &o);
   /**
@@ -186,7 +186,7 @@
    * \param [in] o The PacketTagList to copy.
    *
    * This makes a light-weight copy by #RemoveAll, then
-   * pointing to the same #struct TagData as \pname{o}.
+   * pointing to the same \ref TagData as \pname{o}.
    */
   inline PacketTagList &operator = (PacketTagList const &o);
   /**
@@ -287,7 +287,7 @@
   bool ReplaceWriter (Tag & tag, bool preMerge, struct TagData * cur, struct TagData ** prevNext);
 
   /**
-   * Pointer to first #struct TagData on the list
+   * Pointer to first \ref TagData on the list
    */
   struct TagData *m_next;
 };
--- a/src/network/utils/ascii-file.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/utils/ascii-file.h	Mon Dec 02 23:02:39 2013 +0100
@@ -78,7 +78,7 @@
    * 
    * \param  f1         First ASCII file name
    * \param  f2         Second ASCII file name
-   * \param  lineNumbe   [out] Line number of first different line.
+   * \param  lineNumber   [out] Line number of first different line.
    */
   static bool Diff (std::string const & f1,
 		    std::string const & f2, 
--- a/src/network/utils/error-model.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/utils/error-model.h	Mon Dec 02 23:02:39 2013 +0100
@@ -284,7 +284,7 @@
   /**
    * \param ranVar A random variable distribution to generate random variates
    */
-  void SetRandomVariable (Ptr<RandomVariableStream> ranvar);
+  void SetRandomVariable (Ptr<RandomVariableStream> ranVar);
 
   /**
    * \param burstSz A random variable distribution to generate random burst size
--- a/src/network/utils/red-queue.h	Mon Dec 02 19:36:49 2013 +0100
+++ b/src/network/utils/red-queue.h	Mon Dec 02 23:02:39 2013 +0100
@@ -152,8 +152,8 @@
   /**
    * \brief Set the thresh limits of RED.
    *
-   * \param min Minimum thresh in bytes or packets.
-   * \param max Maximum thresh in bytes or packets.
+   * \param minTh Minimum thresh in bytes or packets.
+   * \param maxTh Maximum thresh in bytes or packets.
    */
   void SetTh (double minTh, double maxTh);