netanim: Correct Doxygen warnings

src/netanim/examples/colors-link-description.cc

@@ -30,10 +30,11 @@ using namespace ns3;
 
 AnimationInterface * pAnim = 0;
 
+/// RGB structure
 struct rgb {
-  uint8_t r;
-  uint8_t g;
-  uint8_t b;
+  uint8_t r; ///< red
+  uint8_t g; ///< green
+  uint8_t b; ///< blue
 };
 
 struct rgb colors [] = {

src/netanim/examples/resources-counters.cc

@@ -30,10 +30,11 @@ using namespace ns3;
 
 AnimationInterface * pAnim = 0;
 
+/// RGB struture
 struct rgb {
-  uint8_t r;
-  uint8_t g;
-  uint8_t b;
+  uint8_t r; ///< red
+  uint8_t g; ///< green
+  uint8_t b; ///< blue
 };
 
 struct rgb colors [] = {

src/netanim/examples/uan-animation.h

@@ -34,27 +34,45 @@ using namespace ns3;
 class NetAnimExperiment
 {
 public:
+  /**
+   * Run function
+   * \param uan the UAN helper
+   */
   void Run (UanHelper &uan);
+  /**
+   * Receive packet function
+   * \param socket the socket to receive from
+   */
   void ReceivePacket (Ptr<Socket> socket);
+  /**
+   * Update positions function
+   * \param nodes the collection of nodes
+   */
   void UpdatePositions (NodeContainer &nodes);
+  /// Reset data function
   void ResetData ();
+  /**
+   * Increment CW function
+   * \param cw the CW
+   */
   void IncrementCw (uint32_t cw);
-  uint32_t m_numNodes;
-  uint32_t m_dataRate;
-  double m_depth;
-  double m_boundary;
-  uint32_t m_packetSize;
-  uint32_t m_bytesTotal;
-  uint32_t m_cwMin;
-  uint32_t m_cwMax;
-  uint32_t m_cwStep;
-  uint32_t m_avgs;
+  uint32_t m_numNodes; ///< number of nodes
+  uint32_t m_dataRate; ///< data rate
+  double m_depth; ///< depth
+  double m_boundary; ///< boundary
+  uint32_t m_packetSize; ///< packet size
+  uint32_t m_bytesTotal; ///< bytes total
+  uint32_t m_cwMin; ///< CW minimum
+  uint32_t m_cwMax; ///< CW maximum
+  uint32_t m_cwStep; ///< CW step
+  uint32_t m_avgs; ///< averages
 
-  Time m_slotTime;
-  Time m_simTime;
+  Time m_slotTime; ///< slot time
+  Time m_simTime; ///< simulation time
 
-  std::vector<double> m_throughputs;
+  std::vector<double> m_throughputs; ///< throughputs
 
+  /// the experiment
   NetAnimExperiment ();
 };
 

src/netanim/model/animation-interface.cc

@@ -66,7 +66,7 @@ NS_LOG_COMPONENT_DEFINE ("AnimationInterface");
 
 // Globals
 
-static bool initialized = false;
+static bool initialized = false; //!< Initialization flag
 
 
 // Public methods

src/netanim/test/netanim-test.cc

@@ -32,6 +32,18 @@
 
 using namespace ns3;
 
+/**
+ * \ingroup netanim-test
+ * \defgroup netanim-test animation module tests
+ */
+
+
+/**
+ * \ingroup netanim-test
+ * \ingroup tests
+ *
+ * \brief Abstract Animation Interface Test Case
+ */
 class AbstractAnimationInterfaceTestCase : public TestCase
 {
 public:
@@ -53,21 +65,21 @@ public:
 
 protected:
 
-  NodeContainer m_nodes;
-  AnimationInterface* m_anim;
+  NodeContainer m_nodes; ///< the nodes
+  AnimationInterface* m_anim; ///< animation
 
 private:
 
-  virtual void
-  PrepareNetwork () = 0;
+  /// Prepare nework function
+  virtual void PrepareNetwork () = 0;
 
-  virtual void
-  CheckLogic () = 0;
+  /// Check logic function
+  virtual void CheckLogic () = 0;
 
-  virtual void
-  CheckFileExistence ();
+  /// Check file existence
+  virtual void CheckFileExistence ();
 
-  const char* m_traceFileName;
+  const char* m_traceFileName; ///< trace file name
 };
 
 AbstractAnimationInterfaceTestCase::AbstractAnimationInterfaceTestCase (std::string name) :
@@ -102,6 +114,12 @@ AbstractAnimationInterfaceTestCase::CheckFileExistence ()
   unlink (m_traceFileName);
 }
 
+/**
+ * \ingroup netanim-test
+ * \ingroup tests
+ *
+ * \brief Animation Interface Test Case
+ */
 class AnimationInterfaceTestCase : public AbstractAnimationInterfaceTestCase
 {
 public:
@@ -169,6 +187,12 @@ AnimationInterfaceTestCase::CheckLogic (void)
   NS_TEST_ASSERT_MSG_EQ (m_anim->GetTracePktCount (), 16, "Expected 16 packets traced");
 }
 
+/**
+ * \ingroup netanim-test
+ * \ingroup tests
+ *
+ * \brief Animation Remaining Energy Test Case
+ */
 class AnimationRemainingEnergyTestCase : public AbstractAnimationInterfaceTestCase
 {
 public:
@@ -185,9 +209,9 @@ private:
   virtual void
   CheckLogic ();
 
-  Ptr<BasicEnergySource> m_energySource;
-  Ptr<SimpleDeviceEnergyModel> m_energyModel;
-  const double m_initialEnergy;
+  Ptr<BasicEnergySource> m_energySource; ///< energy source
+  Ptr<SimpleDeviceEnergyModel> m_energyModel; ///< energy model
+  const double m_initialEnergy; ///< initial energy
 };
 
 AnimationRemainingEnergyTestCase::AnimationRemainingEnergyTestCase () :
@@ -228,6 +252,12 @@ AnimationRemainingEnergyTestCase::CheckLogic (void)
                             "Wrong remaining energy value was traced");
 }
 
+/**
+ * \ingroup netanim-test
+ * \ingroup tests
+ *
+ * \brief Animation Interface Test Suite
+ */
 static class AnimationInterfaceTestSuite : public TestSuite
 {
 public:
@@ -237,4 +267,4 @@ public:
     AddTestCase (new AnimationInterfaceTestCase (), TestCase::QUICK);
     AddTestCase (new AnimationRemainingEnergyTestCase (), TestCase::QUICK);
   }
-} g_animationInterfaceTestSuite;
+} g_animationInterfaceTestSuite; ///< the test suite