[Doxygen] minor fixes
authorTommaso Pecorella <tommaso.pecorella@unifi.it>
Fri, 03 Oct 2014 23:51:58 +0200
changeset 10989 71d2c67a51aa
parent 10988 60f2bc933de1
child 10990 414d94e669c5
[Doxygen] minor fixes
src/bridge/helper/bridge-helper.h
src/dsdv/helper/dsdv-helper.h
src/flow-monitor/model/ipv4-flow-classifier.h
src/flow-monitor/model/ipv6-flow-classifier.h
src/network/helper/simple-net-device-helper.h
src/nix-vector-routing/helper/ipv4-nix-vector-helper.h
src/olsr/helper/olsr-helper.h
src/openflow/helper/openflow-switch-helper.h
src/stats/model/basic-data-calculators.h
src/tap-bridge/helper/tap-bridge-helper.h
src/uan/model/acoustic-modem-energy-model.h
src/uan/model/uan-prop-model-thorp.h
--- a/src/bridge/helper/bridge-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/bridge/helper/bridge-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -71,7 +71,7 @@
    */
   NetDeviceContainer Install (std::string nodeName, NetDeviceContainer c);
 private:
-  ObjectFactory m_deviceFactory;
+  ObjectFactory m_deviceFactory; //!< Object factory
 };
 
 } // namespace ns3
--- a/src/dsdv/helper/dsdv-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/dsdv/helper/dsdv-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -73,7 +73,7 @@
   void Set (std::string name, const AttributeValue &value);
 
 private:
-  ObjectFactory m_agentFactory;
+  ObjectFactory m_agentFactory; //!< Object factory
 };
 
 }
--- a/src/flow-monitor/model/ipv4-flow-classifier.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/flow-monitor/model/ipv4-flow-classifier.h	Fri Oct 03 23:51:58 2014 +0200
@@ -75,6 +75,7 @@
 
   /// Map to Flows Identifiers to FlowIds
   std::map<FiveTuple, FlowId> m_flowMap;
+  /// Map to FlowIds to FlowPacketId
   std::map<FlowId, FlowPacketId> m_flowPktIdMap;
 
 };
--- a/src/flow-monitor/model/ipv6-flow-classifier.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/flow-monitor/model/ipv6-flow-classifier.h	Fri Oct 03 23:51:58 2014 +0200
@@ -76,6 +76,7 @@
 
   /// Map to Flows Identifiers to FlowIds
   std::map<FiveTuple, FlowId> m_flowMap;
+  /// Map to FlowIds to FlowPacketId
   std::map<FlowId, FlowPacketId> m_flowPktIdMap;
 
 };
--- a/src/network/helper/simple-net-device-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/network/helper/simple-net-device-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -174,7 +174,7 @@
    * attaches the provided channel to the device.
    *
    * \param node The node to install the device in
-   * \param channelName The name of the channel to attach to the device.
+   * \param channel The channel to attach to the device.
    * \returns The new net device.
    */
   Ptr<NetDevice> InstallPriv (Ptr<Node> node, Ptr<SimpleChannel> channel) const;
--- a/src/nix-vector-routing/helper/ipv4-nix-vector-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/nix-vector-routing/helper/ipv4-nix-vector-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -36,7 +36,7 @@
 class Ipv4NixVectorHelper : public Ipv4RoutingHelper
 {
 public:
-  /*
+  /**
    * Construct an Ipv4NixVectorHelper to make life easier while adding Nix-vector
    * routing to nodes.
    */
@@ -70,10 +70,11 @@
    * \internal
    * \brief Assignment operator declared private and not implemented to disallow
    * assignment and prevent the compiler from happily inserting its own.
+   * \returns
    */
-  Ipv4NixVectorHelper &operator = (const Ipv4NixVectorHelper &o);
+  Ipv4NixVectorHelper &operator = (const Ipv4NixVectorHelper &);
 
-  ObjectFactory m_agentFactory;
+  ObjectFactory m_agentFactory; //!< Object factory
 };
 } // namespace ns3
 
--- a/src/olsr/helper/olsr-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/olsr/helper/olsr-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -101,11 +101,12 @@
    * \internal
    * \brief Assignment operator declared private and not implemented to disallow
    * assignment and prevent the compiler from happily inserting its own.
+   * \returns
    */
-  OlsrHelper &operator = (const OlsrHelper &o);
-  ObjectFactory m_agentFactory;
+  OlsrHelper &operator = (const OlsrHelper &);
+  ObjectFactory m_agentFactory; //!< Object factory
 
-  std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions;
+  std::map< Ptr<Node>, std::set<uint32_t> > m_interfaceExclusions; //!< container of interfaces excluded from OLSR operations
 };
 
 } // namespace ns3
--- a/src/openflow/helper/openflow-switch-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/openflow/helper/openflow-switch-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -94,7 +94,7 @@
   Install (std::string nodeName, NetDeviceContainer c);
 
 private:
-  ObjectFactory m_deviceFactory;
+  ObjectFactory m_deviceFactory; //!< Object factory
 };
 
 } // namespace ns3
--- a/src/stats/model/basic-data-calculators.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/stats/model/basic-data-calculators.h	Fri Oct 03 23:51:58 2014 +0200
@@ -51,6 +51,10 @@
    */
   void Reset ();
 
+  /**
+   * Outputs the data based on the provided callback
+   * \param callback
+   */
   virtual void Output (DataOutputCallback &callback) const;
 
   /**
--- a/src/tap-bridge/helper/tap-bridge-helper.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/tap-bridge/helper/tap-bridge-helper.h	Fri Oct 03 23:51:58 2014 +0200
@@ -53,7 +53,7 @@
    */
   TapBridgeHelper (Ipv4Address gateway);
 
-  /*
+  /**
    * Set an attribute in the underlying TapBridge net device when these
    * devices are automatically created.
    *
@@ -126,7 +126,7 @@
    */
   Ptr<NetDevice> Install (Ptr<Node> node, Ptr<NetDevice> nd, const AttributeValue &bridgeType);
 private:
-  ObjectFactory m_deviceFactory;
+  ObjectFactory m_deviceFactory; //!< Object factory
 };
 
 } // namespace ns3
--- a/src/uan/model/acoustic-modem-energy-model.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/uan/model/acoustic-modem-energy-model.h	Fri Oct 03 23:51:58 2014 +0200
@@ -158,7 +158,7 @@
   void SetEnergyDepletionCallback (AcousticModemEnergyDepletionCallback callback);
 
   /**
-   * Changes state of the AcousticModemEnergyModel..
+   * Changes state of the AcousticModemEnergyModel.
    *
    * \param newState New state the modem is in.
    */
--- a/src/uan/model/uan-prop-model-thorp.h	Mon Oct 06 22:36:50 2014 -0700
+++ b/src/uan/model/uan-prop-model-thorp.h	Fri Oct 03 23:51:58 2014 +0200
@@ -53,9 +53,9 @@
 
 private:
   /**
-   * Get the attenuation in dB / 1000 yards..
+   * Get the attenuation in dB / 1000 yards.
    * \param freqKhz The channel center frequency, in kHz.
-   * \return The attenuation, in dB / 1000 yards..
+   * \return The attenuation, in dB / 1000 yards.
    */
   double GetAttenDbKyd (double freqKhz);
   /**