doxygen: fix warnings in various modules

src/buildings/helper/building-allocator.cc

@@ -64,11 +64,11 @@ GridBuildingAllocator::GetTypeId (void)
                    DoubleValue (0.0),
                    MakeDoubleAccessor (&GridBuildingAllocator::m_yMin),
                    MakeDoubleChecker<double> ())
-    .AddAttribute ("LengthX", " the length of the wall of each building along the X axis.",
+    .AddAttribute ("LengthX", "The length of the wall of each building along the X axis.",
                    DoubleValue (1.0),
                    MakeDoubleAccessor (&GridBuildingAllocator::m_lengthX),
                    MakeDoubleChecker<double> ())
-    .AddAttribute ("LengthY", " the length of the wall of each building along the X axis.",
+    .AddAttribute ("LengthY", "The length of the wall of each building along the X axis.",
                    DoubleValue (1.0),
                    MakeDoubleAccessor (&GridBuildingAllocator::m_lengthY),
                    MakeDoubleChecker<double> ())

src/buildings/helper/building-allocator.h

@@ -47,7 +47,10 @@ public:
   GridBuildingAllocator ();
   virtual ~GridBuildingAllocator ();
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   /** 
@@ -68,22 +71,25 @@ public:
   BuildingContainer Create (uint32_t n) const;
 
 private:
-
+  /**
+   * Pushes the attributes into the relevant position allocators
+   */
   void PushAttributes () const;
-  mutable uint32_t m_current;
-  enum GridPositionAllocator::LayoutType m_layoutType;
-  double m_xMin;
-  double m_yMin;
-  uint32_t m_n;
-  double m_lengthX;
-  double m_lengthY;
-  double m_deltaX;
-  double m_deltaY;
-  double m_height;
 
-  mutable ObjectFactory m_buildingFactory;
-  Ptr<GridPositionAllocator> m_lowerLeftPositionAllocator;
-  Ptr<GridPositionAllocator> m_upperRightPositionAllocator;
+  mutable uint32_t m_current; //!< current building number
+  enum GridPositionAllocator::LayoutType m_layoutType; //!< Layout type
+  double m_xMin;    //!< The x coordinate where the grid starts
+  double m_yMin;    //!< The y coordinate where the grid starts
+  uint32_t m_n;     //!< The number of objects laid out on a line
+  double m_lengthX; //!< The length of the wall of each building along the X axis.
+  double m_lengthY; //!< The length of the wall of each building along the Y axis.
+  double m_deltaX;  //!< The x space between buildings
+  double m_deltaY;  //!< The y space between buildings
+  double m_height;  //!< The height of the building (roof level)
+
+  mutable ObjectFactory m_buildingFactory; //!< The building factory
+  Ptr<GridPositionAllocator> m_lowerLeftPositionAllocator;  //!< The upper left position allocator
+  Ptr<GridPositionAllocator> m_upperRightPositionAllocator; //!< The upper right position allocator
   
 };
 

src/buildings/helper/building-container.h

@@ -40,6 +40,7 @@ namespace ns3 {
 class BuildingContainer
 {
 public:
+  /// Const iterator
   typedef std::vector<Ptr<Building> >::const_iterator Iterator;
 
   /**
@@ -200,7 +201,7 @@ public:
   static BuildingContainer GetGlobal (void);
 
 private:
-  std::vector<Ptr<Building> > m_buildings;
+  std::vector<Ptr<Building> > m_buildings; //!< Building container
 };
 
 } // namespace ns3

src/buildings/helper/building-position-allocator.h

@@ -35,14 +35,16 @@ class UniformRandomVariable;
 /**
  * Allocate each position by randomly choosing a building from the list
  * of all buildings, and then randomly choosing a position inside the building.
- * 
  */
 class RandomBuildingPositionAllocator : public PositionAllocator
 {
 public:
   RandomBuildingPositionAllocator ();
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   // inherited from PositionAllocator
@@ -60,8 +62,8 @@ public:
 
 private:
 
-  bool m_withReplacement;
-  mutable std::vector< Ptr<Building> > m_buildingListWithoutReplacement;
+  bool m_withReplacement; //!< If true, the building will be randomly selected with replacement
+  mutable std::vector< Ptr<Building> > m_buildingListWithoutReplacement; //!< List of building without replacement
 
   /// Provides uniform random variables.
   Ptr<UniformRandomVariable> m_rand;
@@ -86,7 +88,10 @@ class OutdoorPositionAllocator : public PositionAllocator
 public:
   OutdoorPositionAllocator ();
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   // inherited from PositionAllocator
@@ -137,7 +142,10 @@ class RandomRoomPositionAllocator : public PositionAllocator
 public:
   RandomRoomPositionAllocator ();
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   // inherited from PositionAllocator
@@ -155,14 +163,17 @@ public:
 
 private:
 
+  /**
+   * Room informations
+   */
   struct RoomInfo 
   {
-    Ptr<Building> b;
-    uint32_t roomx;
-    uint32_t roomy;
-    uint32_t floor;
+    Ptr<Building> b; //!< Building
+    uint32_t roomx;  //!< Room (x coord)
+    uint32_t roomy;  //!< Room (y coord)
+    uint32_t floor;  //!< Room (floor number)
   };
-  mutable std::vector<RoomInfo> m_roomListWithoutReplacement;
+  mutable std::vector<RoomInfo> m_roomListWithoutReplacement; //!< Container of rooms
 
   /// Provides uniform random variables.
   Ptr<UniformRandomVariable> m_rand;
@@ -179,9 +190,17 @@ class SameRoomPositionAllocator : public PositionAllocator
 {
 public:
   SameRoomPositionAllocator ();
+
+  /**
+   * Constructor
+   * \param c Node container
+   */
   SameRoomPositionAllocator (NodeContainer c);
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   // inherited from PositionAllocator
@@ -199,8 +218,8 @@ public:
 
 private:
 
-  NodeContainer m_nodes;
-  mutable NodeContainer::Iterator m_nodeIt;
+  NodeContainer m_nodes; //!< Nodes container
+  mutable NodeContainer::Iterator m_nodeIt; //!< Nodes iterator
 
   /// Provides uniform random variables.
   Ptr<UniformRandomVariable> m_rand;
@@ -227,7 +246,10 @@ public:
                               uint32_t y,
                               uint32_t z,
                               Ptr<Building> b);
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
   // inherited from PositionAllocator
   virtual Vector GetNext (void) const;
@@ -244,11 +266,11 @@ public:
 
 private:
 
-  uint32_t roomx;
-  uint32_t roomy;
-  uint32_t floor;
+  uint32_t roomx; //!< Index of the room on the x-axis 
+  uint32_t roomy; //!< Index of the room on the y-axis 
+  uint32_t floor; //!< Index of the room on the z-axis (i.e., floor number)
 
-  Ptr<Building> bptr;
+  Ptr<Building> bptr; //!< Pointer to the chosen building
 
   /// Provides uniform random variables.
   Ptr<UniformRandomVariable> m_rand;

src/buildings/helper/buildings-helper.cc

@@ -48,11 +48,8 @@ BuildingsHelper::Install (Ptr<Node> node)
 {
   Ptr<Object> object = node;
   Ptr<MobilityModel> model = object->GetObject<MobilityModel> ();
-  if (model == 0)
-    {
-      NS_ABORT_MSG_UNLESS (0 != model, "node " << node->GetId () << " does not have a MobilityModel");
 
-    }
+  NS_ABORT_MSG_UNLESS (0 != model, "node " << node->GetId () << " does not have a MobilityModel");
 
   Ptr<MobilityBuildingInfo> buildingInfo = CreateObject<MobilityBuildingInfo> ();
   model->AggregateObject (buildingInfo);

src/buildings/helper/buildings-helper.h

@@ -33,6 +33,9 @@ namespace ns3 {
 class MobilityModel;
 class Building;
 
+/**
+ * Helper used to install a MobilityBuildingInfo into a set of nodes.
+ */
 class BuildingsHelper
 {
 public:

src/buildings/model/building-list.cc

@@ -38,23 +38,66 @@ NS_LOG_COMPONENT_DEFINE ("BuildingList");
 class BuildingListPriv : public Object
 {
 public:
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
   BuildingListPriv ();
   ~BuildingListPriv ();
   
+  /**
+   * Add a Building to the list.
+   * 
+   * \param building building to add
+   * \returns index of building in list.
+   */
   uint32_t Add (Ptr<Building> building);
+  /**
+   * Returns an interator to the start of the list.
+   * 
+   * \returns iterator to the begin of the container.
+   */
   BuildingList::Iterator Begin (void) const;
+  /**
+   * Returns an interator to the end of the list.
+   * 
+   * \returns iterator to the end of the container.
+   */
   BuildingList::Iterator End (void) const;
+  /**
+   * Gets the n-th Building in the container
+   * \param n Building position
+   * \returns a pointer to the Building
+   */
   Ptr<Building> GetBuilding (uint32_t n);
+  /**
+   * Gets the number of Building in the container
+   * \returns the container size
+   */
   uint32_t GetNBuildings (void);
 
+  /**
+   * Get the Singleton instance of BuildingListPriv (or create one)
+   * \return the BuildingListPriv instance
+   */
   static Ptr<BuildingListPriv> Get (void);
 
 private:
   virtual void DoDispose (void);
+  /**
+   * Get the Singleton instance of BuildingListPriv (or create one)
+   * \return the BuildingListPriv instance
+   */
   static Ptr<BuildingListPriv> *DoGet (void);
+  /**
+   * Dispose the Singleton instance of BuildingListPriv.
+   * 
+   * \note: this function is automatically called at the simulation end.
+   * 
+   */
   static void Delete (void);
-  std::vector<Ptr<Building> > m_buildings;
+  std::vector<Ptr<Building> > m_buildings; //!< Container of Building
 };
 
 NS_OBJECT_ENSURE_REGISTERED (BuildingListPriv);

src/buildings/model/building-list.h

@@ -30,9 +30,13 @@ namespace ns3 {
 
 class Building;
 
+/**
+ * Container for Building class
+ */
 class BuildingList
 {
 public:
+  /// Const Iterator
   typedef std::vector< Ptr<Building> >::const_iterator Iterator;
 
   /**

src/buildings/model/building.h

@@ -38,15 +38,23 @@ class Building : public Object
 {
 public:
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
   virtual void DoDispose ();
 
-
+  /**
+   * Building type enum
+   */
   enum BuildingType_t
     {
       Residential, Office, Commercial
     };
+  /**
+   * External building wall type enum
+   */
   enum ExtWallsType_t
     {
       Wood, ConcreteWithWindows, ConcreteWithoutWindows, StoneBlocks
@@ -215,19 +223,19 @@ public:
 
 private:
 
-  Box m_buildingBounds;
+  Box m_buildingBounds; //!< Building boundaries
 
   /**
    * number of floors, must be greater than 0, and 1 means only one floor
    * (i.e., groundfloor)
    */
   uint16_t m_floors;
-  uint16_t m_roomsX;
-  uint16_t m_roomsY;
+  uint16_t m_roomsX; //!< X Room coordinate
+  uint16_t m_roomsY; //!< Y Room coordinate
 
-  uint32_t m_buildingId;
-  BuildingType_t m_buildingType;
-  ExtWallsType_t m_externalWalls;
+  uint32_t m_buildingId; //!< Building ID number
+  BuildingType_t m_buildingType;   //!< Building type
+  ExtWallsType_t m_externalWalls;  //!< External building wall type
 
 };
 

src/buildings/model/buildings-propagation-loss-model.h

@@ -58,6 +58,10 @@ class BuildingsPropagationLossModel : public PropagationLossModel
 {
 
 public:
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   BuildingsPropagationLossModel ();
@@ -72,35 +76,81 @@ public:
   virtual double DoCalcRxPower (double txPowerDbm, Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
 
 protected:
+  /**
+   * Calculate the external wall loss
+   * \param a Building data
+   * \returns the propagation loss (in dBm)
+   */
   double ExternalWallLoss (Ptr<MobilityBuildingInfo> a) const;
+  /**
+   * Calculate the height loss
+   * \param n Building data
+   * \returns the propagation loss (in dBm)
+   */
   double HeightLoss (Ptr<MobilityBuildingInfo> n) const;
+  /**
+   * Calculate the internal wall loss
+   * \param a Room A data
+   * \param b Room B data
+   * \returns the propagation loss (in dBm)
+   */
   double InternalWallsLoss (Ptr<MobilityBuildingInfo> a, Ptr<MobilityBuildingInfo> b) const;
   
+  /**
+   * Calculate the shadowing loss
+   * \param a Room A data
+   * \param b Room B data
+   * \returns the propagation loss (in dBm)
+   */
   double GetShadowing (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
 
-  double m_lossInternalWall; // in meters
-
+  double m_lossInternalWall; //!< loss from internal walls (in dBm)
 
+  /**
+   * \ingroup propagation
+   * 
+   * This model allows the computation of shadowing loss
+   */
   class ShadowingLoss
   {
   public:
     ShadowingLoss ();
+    /**
+     * Constructor
+     * \param shadowingValue Value for shadowing
+     * \param receiver Receiver position
+     */
     ShadowingLoss (double shadowingValue, Ptr<MobilityModel> receiver);
+    /**
+     * \returns the loss (in dBm)
+     */
     double GetLoss () const;
+    /**
+     * \returns the receiver mobility model
+     */
     Ptr<MobilityModel> GetReceiver (void) const;
   protected:
-    double m_shadowingValue;
-    Ptr<MobilityModel> m_receiver;
+    double m_shadowingValue; //!< Shadowing value
+    Ptr<MobilityModel> m_receiver; //!< The receiver mobility model
   };
 
+  /// Map of the shadowng loss
   mutable std::map<Ptr<MobilityModel>,  std::map<Ptr<MobilityModel>, ShadowingLoss> > m_shadowingLossMap;
+  /**
+   * Caluculate the Standard deviation of the normal distribution used for calculate the shadowing
+   * \param a Room A data
+   * \param b Room B data
+   * \return the Standard deviation of the normal distribution
+   */
   double EvaluateSigma (Ptr<MobilityBuildingInfo> a, Ptr<MobilityBuildingInfo> b) const;
 
-
+  /// Standard deviation of the normal distribution used for calculate the shadowing due to ext walls
   double m_shadowingSigmaExtWalls;
+  /// Standard deviation of the normal distribution used for calculate the shadowing for outdoor nodes
   double m_shadowingSigmaOutdoor;
+  /// Standard deviation of the normal distribution used for calculate the shadowing for indoor nodes
   double m_shadowingSigmaIndoor;
-  Ptr<NormalRandomVariable> m_randVariable;
+  Ptr<NormalRandomVariable> m_randVariable; //!< Random variable
 
   virtual int64_t DoAssignStreams (int64_t stream);
 };

src/buildings/model/hybrid-buildings-propagation-loss-model.h

@@ -57,6 +57,10 @@ class HybridBuildingsPropagationLossModel : public BuildingsPropagationLossModel
 {
 
 public:
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
   HybridBuildingsPropagationLossModel ();
   ~HybridBuildingsPropagationLossModel ();
@@ -91,6 +95,9 @@ public:
   void SetRooftopHeight (double rooftopHeight);
 
   /**
+   * \brief Compute the path loss according to the nodes position
+   * using the appropriate model.
+   * 
    * \param a the mobility model of the source
    * \param b the mobility model of the destination
    * \returns the propagation loss (in dBm)
@@ -99,20 +106,47 @@ public:
 
   
 private:
-
+  /**
+   * Compute the path loss using either OkumuraHataPropagationLossModel 
+   * or Kun2600MhzPropagationLossModel
+   * 
+   * \param a the mobility model of the source
+   * \param b the mobility model of the destination
+   * \returns the propagation loss (in dBm)
+   */
   double OkumuraHata (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
+  /**
+   * Compute the path loss using either ItuR1411LosPropagationLossModelor
+   * ItuR1411NlosOverRooftopPropagationLossModel
+   * 
+   * \param a the mobility model of the source
+   * \param b the mobility model of the destination
+   * \returns the propagation loss (in dBm)
+   */
   double ItuR1411 (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
+  /**
+   * Compute the path loss using ItuR1238PropagationLossModel
+   * 
+   * \param a the mobility model of the source
+   * \param b the mobility model of the destination
+   * \returns the propagation loss (in dBm)
+   */
   double ItuR1238 (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
 
+  /// OkumuraHataPropagationLossModel
   Ptr<OkumuraHataPropagationLossModel> m_okumuraHata;
+  /// ItuR1411LosPropagationLossModel
   Ptr<ItuR1411LosPropagationLossModel> m_ituR1411Los;
+  /// ItuR1411NlosOverRooftopPropagationLossModel
   Ptr<ItuR1411NlosOverRooftopPropagationLossModel> m_ituR1411NlosOverRooftop;
+  /// ItuR1238PropagationLossModel
   Ptr<ItuR1238PropagationLossModel> m_ituR1238;
+  /// Kun2600MhzPropagationLossModel
   Ptr<Kun2600MhzPropagationLossModel> m_kun2600Mhz;
 
   double m_itu1411NlosThreshold; ///< in meters (switch Los -> NLoS)
-  double m_rooftopHeight;
-  double m_frequency;
+  double m_rooftopHeight;        ///< Roof Height (in meters)
+  double m_frequency;            ///< Operation frequency
 
 };
 

src/buildings/model/itu-r-1238-propagation-loss-model.h

@@ -37,7 +37,10 @@ class ItuR1238PropagationLossModel : public PropagationLossModel
 
 public:
 
-  // inherited from Object
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
 
   /** 

src/buildings/model/oh-buildings-propagation-loss-model.h

@@ -40,6 +40,10 @@ class OhBuildingsPropagationLossModel : public BuildingsPropagationLossModel
 {
 
 public:
+  /**
+   * \brief Get the type ID.
+   * \return The object TypeId.
+   */
   static TypeId GetTypeId (void);
   OhBuildingsPropagationLossModel ();
   ~OhBuildingsPropagationLossModel ();
@@ -53,7 +57,7 @@ public:
   
 private:
 
-  Ptr<OkumuraHataPropagationLossModel> m_okumuraHata;
+  Ptr<OkumuraHataPropagationLossModel> m_okumuraHata; //!< OkumuraHata Propagation Loss Model
 
 };
 

src/buildings/model/random-walk-2d-outdoor-mobility-model.h

@@ -77,15 +77,16 @@ private:
   void Rebound (Time timeLeft);
   /**
    * \brief Avoid a building
-   * \param timeLeft The remaining time of the walk
+   * \param delayLeft The remaining time of the walk
    * \param intersectPosition The position at which the building is intersected
    */
   void AvoidBuilding (Time delayLeft, Vector intersectPosition);
   /**
    * Walk according to position and velocity, until distance is reached,
    * time is reached, or intersection with the bounding box, or building
+   * \param delayLeft The remaining time of the walk
    */
-  void DoWalk (Time timeLeft);
+  void DoWalk (Time delayLeft);
   /**
    * Perform initialization of the object before MobilityModel::DoInitialize ()
    */

src/buildings/model/three-gpp-v2v-channel-condition-model.h

@@ -159,7 +159,7 @@ private:
    * \link BuildingsChannelConditionModel \endlink, which requires
    * \link MobilityBuildingInfo \endlink aggregated to the nodes to compute
    * LOS and NLOS. Otherwise, the callback is hooked to a local method
-   * \link GetChaCondWithNoBuildings \endlink
+   * \link GetChCondWithNoBuildings \endlink
    * , which construct the ChannelCondtion object and set the condition to
    * outdoor to outdoor with LOS.
    */
@@ -167,8 +167,8 @@ private:
 
   /**
    * \brief Get the channel condition and redirect the callback
-   * \link ComputeChCond \endlink to \link GetChaCondWithBuildings \endlink
-   * or to \link GetChaCondWithNoBuildings \endlink depending on if there are
+   * \link ComputeChCond \endlink to \link GetChCondWithBuildings \endlink
+   * or to \link GetChCondWithNoBuildings \endlink depending on if there are
    * buildings in the scenario or not.
    *
    * \param a tx mobility model

src/buildings/test/building-position-allocator-test.cc

@@ -36,12 +36,29 @@ using namespace ns3;
 
 NS_LOG_COMPONENT_DEFINE ("BuildingPositionAllocatorTest");
 
+/**
+ * \ingroup propagation
+ * \defgroup building-test Buildings module tests
+ */
+
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * Room coordinates
+ */
 struct Room
 {
+  /**
+   * Constructor
+   * \param xx X coord
+   * \param yy Y coord
+   * \param zz Z coord
+   */
   Room (uint32_t xx, uint32_t yy, uint32_t zz);
-  uint32_t x;
-  uint32_t y;
-  uint32_t z;
+  uint32_t x; //!< X coord
+  uint32_t y; //!< Y coord
+  uint32_t z; //!< Z coord (floor)
 };
 
 Room::Room (uint32_t xx, uint32_t yy, uint32_t zz)
@@ -60,7 +77,12 @@ operator < (const Room& a, const Room& b)
 }
 
 
-
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * RandomRoomPositionAllocator test
+ */
 class RandomRoomPositionAllocatorTestCase : public TestCase
 {
 public:
@@ -139,8 +161,12 @@ RandomRoomPositionAllocatorTestCase::DoRun ()
 
 
 
-
-
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * SameRoomPositionAllocator test
+ */
 class SameRoomPositionAllocatorTestCase : public TestCase
 {
 public:
@@ -214,17 +240,18 @@ SameRoomPositionAllocatorTestCase::DoRun ()
 }
 
 
-
-
-
-
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * \brief RandomRoomPositionAllocator TestSuite
+ */
 class BuildingPositionAllocatorTestSuite : public TestSuite
 {
 public:
   BuildingPositionAllocatorTestSuite ();
 };
 
-
 BuildingPositionAllocatorTestSuite::BuildingPositionAllocatorTestSuite ()
   : TestSuite ("building-position-allocator", UNIT)
 {
@@ -235,4 +262,5 @@ BuildingPositionAllocatorTestSuite::BuildingPositionAllocatorTestSuite ()
 
 }
 
+/// Static variable for test initialization
 static BuildingPositionAllocatorTestSuite buildingsPositionAllocatorTestSuiteInstance; 

src/buildings/test/buildings-channel-condition-model-test.cc

@@ -31,6 +31,9 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE ("BuildingsChannelConditionModelsTest");
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
  * Test case for the class BuildingsChannelConditionModel. It checks if the
  * channel condition is correctly determined when a building is deployed in the
  * scenario
@@ -140,6 +143,8 @@ BuildingsChannelConditionModelTestCase::DoRun (void)
 }
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
  * Test suite for the buildings channel condition model
  */
 class BuildingsChannelConditionModelsTestSuite : public TestSuite
@@ -154,4 +159,5 @@ BuildingsChannelConditionModelsTestSuite::BuildingsChannelConditionModelsTestSui
   AddTestCase (new BuildingsChannelConditionModelTestCase, TestCase::QUICK);
 }
 
+/// Static variable for test initialization
 static BuildingsChannelConditionModelsTestSuite BuildingsChannelConditionModelsTestSuite;

src/buildings/test/buildings-helper-test.cc

@@ -33,15 +33,21 @@ using namespace ns3;
 
 NS_LOG_COMPONENT_DEFINE ("BuildingsHelperTest");
 
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * \brief Struct representing a position in a building
+ */
 struct PositionInBuilding
 {
   PositionInBuilding ();
-  Vector   pos;   // coordinates of the mobility model instance
-  bool     indoor; // true if indoor, false otherwise
-  uint32_t bid;   // building id
-  uint16_t rx;    // room x
-  uint16_t ry;    // room y
-  uint16_t fn;    // floor number
+  Vector   pos;   //!< coordinates of the mobility model instance
+  bool     indoor; //!< true if indoor, false otherwise
+  uint32_t bid;   //!< building id
+  uint16_t rx;    //!< room x
+  uint16_t ry;    //!< room y
+  uint16_t fn;    //!< floor number
 };
 
 PositionInBuilding::PositionInBuilding ()
@@ -55,7 +61,10 @@ PositionInBuilding::PositionInBuilding ()
 }
 
 /**
- * data to construct a Building object. We don't want to pass Building
+ * \ingroup building-test
+ * \ingroup tests
+
+ * Data to construct a Building object. We don't want to pass Building
  * objects to the TestCase constructor because otherwise BuildingList
  * would contain all of them (even if only one is meant to be in the
  * test case).
@@ -64,15 +73,15 @@ PositionInBuilding::PositionInBuilding ()
 struct BuildingData
 {
   BuildingData ();
-  double xmin;
-  double xmax;
-  double ymin;
-  double ymax;
-  double zmin;
-  double zmax;
-  uint16_t nrx;
-  uint16_t nry;
-  uint16_t nf;
+  double xmin;   //!< X min coordinate
+  double xmax;   //!< X max coordinate
+  double ymin;   //!< Y min coordinate
+  double ymax;   //!< Y max coordinate
+  double zmin;   //!< Z min coordinate
+  double zmax;   //!< Z max coordinate
+  uint16_t nrx;  //!< Number of rooms (X coord)
+  uint16_t nry;  //!< Number of rooms (Y coord)
+  uint16_t nf;   //!< Number of floors
 };
 
 BuildingData::BuildingData ()
@@ -88,17 +97,35 @@ BuildingData::BuildingData ()
 {
 }
 
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * \brief BuildingsHelper test 
+ */
 class BuildingsHelperOneTestCase : public TestCase
 {
 public:
+  /**
+   * Build the testcase name
+   * \param pib Position in building
+   * \param bd Building data
+   * \return the TestCase name
+   */
   static std::string BuildNameString (PositionInBuilding pib, BuildingData bd);
+
+  /**
+   * Constructor
+   * \param pib Position in building
+   * \param bd Building data
+   */
   BuildingsHelperOneTestCase (PositionInBuilding pib, BuildingData bd);
 
 private:
   virtual void DoRun (void);
 
-  PositionInBuilding m_pib;
-  BuildingData m_bd;
+  PositionInBuilding m_pib; //!< Position in the building
+  BuildingData m_bd; //!< Building data
   
 };
 
@@ -167,11 +194,12 @@ BuildingsHelperOneTestCase::DoRun ()
 }
 
 
-
-
-
-
-
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * \brief BuildingsHelper TestSuite
+ */
 class BuildingsHelperTestSuite : public TestSuite
 {
 public:
@@ -322,4 +350,5 @@ BuildingsHelperTestSuite::BuildingsHelperTestSuite ()
   AddTestCase (new BuildingsHelperOneTestCase (q7, b2), TestCase::QUICK);     
 }
 
+/// Static variable for test initialization
 static BuildingsHelperTestSuite buildingsHelperAntennaTestSuiteInstance;

src/buildings/test/buildings-pathloss-test.cc

@@ -38,16 +38,12 @@ using namespace ns3;
 
 NS_LOG_COMPONENT_DEFINE ("BuildingsPathlossTest");
 
-/**
+/*
  * Test 1.1 BuildingsPathlossModel Pathloss compound test
- */
-
-/**
+ *
  * This TestSuite tests the BuildingPathlossModel by reproducing
  * several communication scenarios 
  */
-
-
 BuildingsPathlossTestSuite::BuildingsPathlossTestSuite ()
   : TestSuite ("buildings-pathloss-test", SYSTEM)
 {
@@ -127,11 +123,11 @@ BuildingsPathlossTestSuite::BuildingsPathlossTestSuite ()
 }
 
 
-
+/// Static variable for test initialization
 static BuildingsPathlossTestSuite buildingsPathlossTestSuite;
 
 
-/**
+/*
  * TestCase
  */
 

src/buildings/test/buildings-pathloss-test.h

@@ -28,8 +28,14 @@
 using namespace ns3;
 
 /**
-* Test 1.1 pathloss calculation
-*/
+ * \ingroup building-test
+ * \ingroup tests
+ *
+ * Test 1.1 BuildingsPathlossModel Pathloss compound test
+ *
+ * This TestSuite tests the BuildingPathlossModel by reproducing
+ * several communication scenarios 
+ */
 class BuildingsPathlossTestSuite : public TestSuite
 {
 public:
@@ -37,22 +43,44 @@ public:
 };
 
 
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ *
+ * Test 1.1 BuildingsPathlossModel Pathloss test
+ *
+ */
 class BuildingsPathlossTestCase : public TestCase
 {
 public:
+  /**
+   * Constructor
+   * \param freq Communication frequency
+   * \param m1 First MobilityModel Index
+   * \param m2 Second MobilityModel Index
+   * \param env Enviroment type
+   * \param city City size
+   * \param refValue Theoretical loss
+   * \param name Test name
+   */
   BuildingsPathlossTestCase (double freq, uint16_t m1, uint16_t m2, EnvironmentType env, CitySize city, double refValue, std::string name);
   virtual ~BuildingsPathlossTestCase ();
 
 private:
   virtual void DoRun (void);
+  /**
+   * Create a mobility model based on its index
+   * \param index MobilityModel index
+   * \return The MobilityModel
+   */
   Ptr<MobilityModel> CreateMobilityModel (uint16_t index);
 
-  double m_freq;
-  uint16_t m_mobilityModelIndex1;
-  uint16_t m_mobilityModelIndex2;
-  EnvironmentType m_env;
-  CitySize m_city;
-  double m_lossRef;
+  double m_freq; //!< Communication frequency
+  uint16_t m_mobilityModelIndex1; //!< First MobilityModel Index
+  uint16_t m_mobilityModelIndex2; //!< Second MobilityModel Index
+  EnvironmentType m_env; //!< Enviroment type
+  CitySize m_city; //!< City size
+  double m_lossRef; //!< Theoretical loss
 
 };
 

src/buildings/test/buildings-shadowing-test.cc

@@ -38,11 +38,9 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE ("BuildingsShadowingTest");
 
 
-/**
+/*
 * Test 1.1 Shadowing compound test
-*/
-
-/**
+*
 * This TestSuite tests the shadowing model of BuildingPathlossModel 
 * by reproducing several communication scenarios 
 */
@@ -65,10 +63,11 @@ BuildingsShadowingTestSuite::BuildingsShadowingTestSuite ()
 
 }
 
+/// Static variable for test initialization
 static BuildingsShadowingTestSuite buildingsShadowingTestSuite;
 
 
-/**
+/*
 * TestCase
 */
 

src/buildings/test/buildings-shadowing-test.h

@@ -28,7 +28,13 @@
 using namespace ns3;
 
 /**
- * Test shadowing calculation
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * Shadowing compound test
+ *
+ * This TestSuite tests the shadowing model of BuildingPathlossModel 
+ * by reproducing several communication scenarios 
  */
 class BuildingsShadowingTestSuite : public TestSuite
 {
@@ -37,20 +43,39 @@ public:
 };
 
 
+/**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
+ * Shadowing test
+ */
 class BuildingsShadowingTestCase : public TestCase
 {
 public:
+  /**
+   * Constructor
+   * \param m1 First MobilityModel Index
+   * \param m2 Second MobilityModel Index
+   * \param refValue Theoretical loss
+   * \param sigmaRef Theoretical loss standard deviation
+   * \param name Test name
+   */
   BuildingsShadowingTestCase (uint16_t m1, uint16_t m2, double refValue, double sigmaRef, std::string name);
   virtual ~BuildingsShadowingTestCase ();
 
 private:
   virtual void DoRun (void);
+  /**
+   * Create a mobility model based on its index
+   * \param index MobilityModel index
+   * \return The MobilityModel
+   */
   Ptr<MobilityModel> CreateMobilityModel (uint16_t index);
 
-  uint16_t m_mobilityModelIndex1;
-  uint16_t m_mobilityModelIndex2;
-  double m_lossRef;     // pathloss value (without shadowing)
-  double m_sigmaRef;
+  uint16_t m_mobilityModelIndex1;  //!< First MobilityModel Index
+  uint16_t m_mobilityModelIndex2;  //!< Second MobilityModel Index
+  double m_lossRef;     //!< pathloss value (without shadowing)
+  double m_sigmaRef;    //!< pathloss standard deviation value reference value
 
 };
 

src/buildings/test/outdoor-random-walk-test.cc

@@ -34,31 +34,28 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE ("OutdoorRandomWalkTest");
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
  * Test case for the class OutdoorRandomWalkTestCase. It checks if the
  * positions visited by the user are outside buildings
  */
 class OutdoorRandomWalkTestCase : public TestCase
 {
 public:
-  /**
-   * Constructor
-   */
   OutdoorRandomWalkTestCase ();
-
-  /**
-   * Destructor
-   */
   virtual ~OutdoorRandomWalkTestCase ();
 
 private:
-  /**
-   * Builds the simulation scenario and perform the tests
-   */
   virtual void DoRun (void);
 
+  /**
+   * Check that the position is the expected one
+   * \param model Mobility model
+   */
   void CheckPositionOutdoor (Ptr<RandomWalk2dOutdoorMobilityModel> model);
 
-  std::vector<Ptr<Building> > m_buildings;
+  std::vector<Ptr<Building> > m_buildings; //!< Buildings
 };
 
 OutdoorRandomWalkTestCase::OutdoorRandomWalkTestCase ()
@@ -150,6 +147,9 @@ OutdoorRandomWalkTestCase::DoRun (void)
 }
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
  * Test suite for the buildings channel condition model
  */
 class OutdoorRandomWalkTestSuite : public TestSuite
@@ -164,4 +164,5 @@ OutdoorRandomWalkTestSuite::OutdoorRandomWalkTestSuite ()
   AddTestCase (new OutdoorRandomWalkTestCase, TestCase::QUICK);
 }
 
+/// Static variable for test initialization
 static OutdoorRandomWalkTestSuite OutdoorRandomWalkTestSuite;

src/buildings/test/three-gpp-v2v-channel-condition-model-test.cc

@@ -38,6 +38,9 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE ("ThreeGppV2vChannelConditionModelsTest");
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
  * Test case for the classes ThreeGppV2vUrbanChannelConditionModel,
  * and ThreeGppV2vHighwayChannelConditionModel to test their code to
  * deterministically determine NLOS state. The test checks if the
@@ -473,6 +476,9 @@ ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun (void)
 
 
 /**
+ * \ingroup building-test
+ * \ingroup tests
+ * 
  * Test suite for the 3GPP V2V channel condition model
  *
  * Note that, in 3GPP V2V scenarios, the channel condition model is
@@ -483,8 +489,8 @@ ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun (void)
  *
  * The test ThreeGppV2vBuildingsChCondModelTestCase checks the
  * 1st step of the procedure, the deterministic one, using buildings for
- * both \link ThreeGppV2vUrbanChannelConditionModel \endlink and
- * \link ThreeGppV2vHighwayChannelConditionModel \endlink .
+ * both \link ns3::ThreeGppV2vUrbanChannelConditionModel \endlink and
+ * \link ns3::ThreeGppV2vHighwayChannelConditionModel \endlink .
  *
  * The tests ThreeGppV2vUrbanLosNlosvChCondModelTestCase and
  * ThreeGppV2vHighwayLosNlosvChCondModelTestCase check the
@@ -506,4 +512,5 @@ ThreeGppV2vChCondModelsTestSuite::ThreeGppV2vChCondModelsTestSuite ()
   AddTestCase (new ThreeGppV2vHighwayLosNlosvChCondModelTestCase, TestCase::QUICK); // test for the probabilistic procedure (LOS vs NLOSv), in V2V highway scenario
 }
 
+/// Static variable for test initialization
 static ThreeGppV2vChCondModelsTestSuite ThreeGppV2vChCondModelsTestSuite;

src/core/model/int64x64-cairo.h

@@ -286,15 +286,12 @@ public:
 private:
 
   /**
-   * \name Arithmetic Operators
-   * Arithmetic operators for int64x64_t.
-   */
-  /**
-   * @{
-   *  Arithmetic operator.
+   * \defgroup AritmeticOps Arithmetic Operators
+   * \brief Arithmetic operators for int64x64_t.
    * \param [in] lhs Left hand argument
    * \param [in] rhs Right hand argument
    * \return The result of the operator.
+   * @{
    */
   friend bool         operator == (const int64x64_t & lhs, const int64x64_t & rhs);
 
@@ -305,21 +302,18 @@ private:
   friend int64x64_t & operator -= (      int64x64_t & lhs, const int64x64_t & rhs);
   friend int64x64_t & operator *= (      int64x64_t & lhs, const int64x64_t & rhs);
   friend int64x64_t & operator /= (      int64x64_t & lhs, const int64x64_t & rhs);
-  /**@}*/
+  /** @} */
 
   /**
-   * \name Unary Operators
-   * Unary operators for int64x64_t.
-   */
-  /**
-   * @{
-   *  Unary operator.
+   * \defgroup UnaryOps Unary Operators
+   * \brief Unary operators for int64x64_t.
    * \param [in] lhs Left hand argument
    * \return The result of the operator.
+   * @{
    */
   friend int64x64_t   operator -  (const int64x64_t & lhs);
   friend int64x64_t   operator !  (const int64x64_t & lhs);
-  /**@}*/
+  /** @} */
 
   /**
    * Implement `*=`.

src/core/model/system-thread.h

@@ -163,6 +163,7 @@ private:
    *
    * @param [in] arg This SystemThread instance to communicate to the newly
    *                 launched thread.
+   * @return a null pointer (for compatibility)
    */
   static void * DoRun (void *arg);
 
@@ -174,5 +175,3 @@ private:
 } // namespace ns3
 
 #endif /* SYSTEM_THREAD_H */
-
-

src/dsdv/model/dsdv-routing-protocol.h

@@ -217,9 +217,15 @@ private:
    */
   void
   RecvDsdv (Ptr<Socket> socket);
-  /// Send packet
+  /**
+   * Send a packet
+   * \param route the route
+   * \param packet the packet
+   * \param header the IPv4 header
+   */
   void
-  Send (Ptr<Ipv4Route>, Ptr<const Packet>, const Ipv4Header &);
+  Send (Ptr<Ipv4Route> route, Ptr<const Packet> packet, const Ipv4Header & header);
+
   /**
    * Create loopback route for given header
    *
@@ -245,9 +251,14 @@ private:
   /// Merge periodic updates
   void
   MergeTriggerPeriodicUpdates ();
-  /// Notify that packet is dropped for some reason
+  /**
+   * Notify that packet is dropped for some reason
+   * \param packet the dropped packet
+   * \param header the IPv4 header
+   * \param err the error number
+   */
   void
-  Drop (Ptr<const Packet>, const Ipv4Header &, Socket::SocketErrno);
+  Drop (Ptr<const Packet> packet, const Ipv4Header & header, Socket::SocketErrno err);
   /// Timer to trigger periodic updates from a node
   Timer m_periodicUpdateTimer;
   /// Timer used by the trigger updates in case of Weighted Settling Time is used

src/dsdv/model/dsdv-rtable.h

@@ -276,6 +276,7 @@ public:
   /**
    * Print routing table entry
    * \param stream the output stream
+   * \param unit the Time unit
    */
   void
   Print (Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S) const;
@@ -393,6 +394,7 @@ public:
   /**
    * Print routing table
    * \param stream the output stream
+   * \param unit the Time unit
    */
   void
   Print (Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S) const;

src/lte/model/epc-gtpc-header.h

@@ -51,6 +51,13 @@ public:
   virtual uint32_t Deserialize (Buffer::Iterator start);
   virtual void Print (std::ostream &os) const;
 
+  /**
+   * Get the message size.
+   * 
+   * Subclasses are supposed to have a message size greater than zero.
+   * 
+   * \returns the message size
+   */
   virtual uint32_t GetMessageSize (void) const;
 
   /**
@@ -100,6 +107,9 @@ public:
    */
   void SetIesLength (uint16_t iesLength);
 
+  /**
+   * Compute the message length according to the message type
+   */
   void ComputeMessageLength (void);
 
   /// Interface Type enumeration
@@ -116,9 +126,9 @@ public:
   /// FTEID structure
   struct Fteid_t
   {
-    InterfaceType_t interfaceType;
-    Ipv4Address addr;
-    uint32_t teid;
+    InterfaceType_t interfaceType; //!< Interface type
+    Ipv4Address addr; //!< IPv4 address
+    uint32_t teid; //!< TEID
   };
 
   /// Message Type enumeration
@@ -173,61 +183,178 @@ protected:
   /**
    * Deserialize the GTP-C header in the GTP-C messages
    * \param i the buffer iterator
+   * \return number of bytes deserialized
    */
   uint32_t PreDeserialize (Buffer::Iterator &i);
 
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Information Elemements
+ */
 class GtpcIes
 {
 public:
+  /**
+   * Cause
+   */
   enum Cause_t
   {
     RESERVED          = 0,
     REQUEST_ACCEPTED  = 16,
   };
 
-  const uint32_t serializedSizeImsi = 12;
-  const uint32_t serializedSizeCause = 6;
-  const uint32_t serializedSizeEbi = 5;
-  const uint32_t serializedSizeBearerQos = 26;
-  const uint32_t serializedSizePacketFilter = 3 + 9 + 9 + 5 + 5 + 3;
+  const uint32_t serializedSizeImsi = 12; //!< IMSI serialized size
+  const uint32_t serializedSizeCause = 6; //!< Cause serialized size
+  const uint32_t serializedSizeEbi = 5;   //!< EBI serialized size
+  const uint32_t serializedSizeBearerQos = 26;  //!< Bearer QoS serialized size
+  const uint32_t serializedSizePacketFilter = 3 + 9 + 9 + 5 + 5 + 3; //!< Packet filter serialized size
+  /**
+   * \return the BearerTft serialized size
+   * \param packetFilters The packet filter
+   */
   uint32_t GetSerializedSizeBearerTft (std::list<EpcTft::PacketFilter> packetFilters) const;
-  const uint32_t serializedSizeUliEcgi = 12;
-  const uint32_t serializedSizeFteid = 13;
-  const uint32_t serializedSizeBearerContextHeader = 4;
-
+  const uint32_t serializedSizeUliEcgi = 12; //!< UliEcgi serialized size
+  const uint32_t serializedSizeFteid = 13;   //!< Fteid serialized size
+  const uint32_t serializedSizeBearerContextHeader = 4;  //!< Fteid serialized size
 
+  /**
+   * Serialize the IMSI
+   * \param i Buffer iterator 
+   * \param imsi The IMSI
+   */
   void SerializeImsi (Buffer::Iterator &i, uint64_t imsi) const;
+  /**
+   * Deserialize the IMSI
+   * \param i Buffer iterator 
+   * \param [out] imsi The IMSI
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeImsi (Buffer::Iterator &i, uint64_t &imsi);
 
+  /**
+   * Serialize the Cause
+   * \param i Buffer iterator 
+   * \param cause The Cause
+   */
   void SerializeCause (Buffer::Iterator &i, Cause_t cause) const;
+  /**
+   * Deserialize the Cause
+   * \param i Buffer iterator 
+   * \param [out] cause The cause
+   * \return the number of deserialized bytes
+   */
    uint32_t DeserializeCause (Buffer::Iterator &i, Cause_t &cause);
 
+  /**
+   * Serialize the eps Bearer Id
+   * \param i Buffer iterator 
+   * \param  epsBearerId The eps Bearer Id
+   */
   void SerializeEbi (Buffer::Iterator &i, uint8_t epsBearerId) const;
+  /**
+   * Deserialize the eps Bearer Id
+   * \param i Buffer iterator 
+   * \param [out] epsBearerId The eps Bearer Id
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeEbi (Buffer::Iterator &i, uint8_t &epsBearerId);
 
+  /**
+   * \param i Buffer iterator 
+   * \param data data to write in buffer
+   *
+   * Write the data in buffer and advance the iterator position
+   * by five bytes. The data is written in network order and the
+   * input data is expected to be in host order.
+   */
   void WriteHtonU40 (Buffer::Iterator &i, uint64_t data) const;
+  /**
+   * \param i Buffer iterator 
+   * \return the five bytes read in the buffer.
+   *
+   * Read data and advance the Iterator by the number of bytes
+   * read.
+   * The data is read in network format and returned in host format.
+   */
   uint64_t ReadNtohU40 (Buffer::Iterator &i);
 
+  /**
+   * Serialize the eps Bearer QoS
+   * \param i Buffer iterator 
+   * \param bearerQos The Bearer QoS
+   */
   void SerializeBearerQos (Buffer::Iterator &i, EpsBearer bearerQos) const;
+  /**
+   * Deserialize the eps Bearer QoS
+   * \param i Buffer iterator 
+   * \param [out] bearerQos The Bearer QoS
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeBearerQos (Buffer::Iterator &i, EpsBearer &bearerQos);
 
+  /**
+   * Serialize the Bearer TFT
+   * \param i Buffer iterator 
+   * \param packetFilters The Packet filters
+   */
   void SerializeBearerTft (Buffer::Iterator &i, std::list<EpcTft::PacketFilter> packetFilters) const;
+  /**
+   * Deserialize the Bearer TFT
+   * \param i Buffer iterator 
+   * \param [out] epcTft The Bearer TFT
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeBearerTft (Buffer::Iterator &i, Ptr<EpcTft> epcTft);
 
+  /**
+   * Serialize the UliEcgi
+   * \param i Buffer iterator 
+   * \param uliEcgi The UliEcgi
+   */
   void SerializeUliEcgi (Buffer::Iterator &i, uint32_t uliEcgi) const;
+  /**
+   * Deserialize the UliEcgi
+   * \param i Buffer iterator 
+   * \param [out] uliEcgi UliEcgi
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeUliEcgi (Buffer::Iterator &i, uint32_t &uliEcgi);
 
+  /**
+   * Serialize the Fteid_t
+   * \param i Buffer iterator 
+   * \param fteid The Fteid_t
+   */
   void SerializeFteid (Buffer::Iterator &i, GtpcHeader::Fteid_t fteid) const;
+  /**
+   * Deserialize the Fteid
+   * \param i Buffer iterator 
+   * \param [out] fteid Fteid
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeFteid (Buffer::Iterator &i, GtpcHeader::Fteid_t &fteid);
 
+  /**
+   * Serialize the Bearer Context Header
+   * \param i Buffer iterator 
+   * \param length The length
+   */
   void SerializeBearerContextHeader (Buffer::Iterator &i, uint16_t length) const;
+  /**
+   * Deserialize the Bearer Context Header
+   * \param i Buffer iterator 
+   * \param [out] length length
+   * \return the number of deserialized bytes
+   */
   uint32_t DeserializeBearerContextHeader (Buffer::Iterator &i, uint16_t &length);
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Create Session Request Message
+ */
 class GtpcCreateSessionRequestMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -245,15 +372,42 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the IMSI
+   * \return IMSI
+   */
   uint64_t GetImsi () const;
+  /**
+   * Set the IMSI
+   * \param imsi IMSI
+   */
   void SetImsi (uint64_t imsi);
 
+  /**
+   * Get the UliEcgi
+   * \return UliEcgi
+   */
   uint32_t GetUliEcgi () const;
+  /**
+   * Set the UliEcgi
+   * \param uliEcgi UliEcgi
+   */
   void SetUliEcgi (uint32_t uliEcgi);
 
+  /**
+   * Get the Sender CpFteid
+   * \return Sender CpFteid
+   */
   GtpcHeader::Fteid_t GetSenderCpFteid () const;
+  /**
+   * Set the Sender CpFteid
+   * \param fteid Sender CpFteid
+   */
   void SetSenderCpFteid (GtpcHeader::Fteid_t fteid);
 
+  /**
+   * Bearer Context structure
+   */
   struct BearerContextToBeCreated
   {
     GtpcHeader::Fteid_t sgwS5uFteid; ///< FTEID
@@ -262,18 +416,30 @@ public:
     EpsBearer bearerLevelQos; ///< bearer QOS level
   };
 
+  /**
+   * Get the Bearer Contexts
+   * \return the Bearer Context list
+   */
   std::list<BearerContextToBeCreated> GetBearerContextsToBeCreated () const;
+  /**
+   * Set the Bearer Contexts
+   * \param bearerContexts the Bearer Context list
+   */
   void SetBearerContextsToBeCreated (std::list<BearerContextToBeCreated> bearerContexts);
 
 private:
-  uint64_t m_imsi;
-  uint32_t m_uliEcgi;
-  GtpcHeader::Fteid_t m_senderCpFteid;
+  uint64_t m_imsi; //!< IMSI
+  uint32_t m_uliEcgi; //!< UliEcgi
+  GtpcHeader::Fteid_t m_senderCpFteid; //!< Sender CpFteid
 
+  /// Bearer Context list
   std::list<BearerContextToBeCreated> m_bearerContextsToBeCreated;
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Create Session Response Message
+ */
 class GtpcCreateSessionResponseMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -291,12 +457,31 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the Cause
+   * \return the Cause
+   */
   Cause_t GetCause () const;
+  /**
+   * Set the Cause
+   * \param cause The cause
+   */
   void SetCause (Cause_t cause);
 
+  /**
+   * Get the Sender CpFteid
+   * \return the Sender CpFteid
+   */
   GtpcHeader::Fteid_t GetSenderCpFteid () const;
+  /**
+   * Set the Sender CpFteid
+   * \param fteid the Sender CpFteid
+   */
   void SetSenderCpFteid (GtpcHeader::Fteid_t fteid);
 
+  /**
+   * Bearer Context structure
+   */
   struct BearerContextCreated
   {
     uint8_t epsBearerId; ///< EPS bearer ID
@@ -306,17 +491,29 @@ public:
     EpsBearer bearerLevelQos; ///< Bearer QOS level
   };
 
+  /**
+   * Get the Container of Bearer Contexts
+   * \return a list of Bearer Contexts
+   */
   std::list<BearerContextCreated> GetBearerContextsCreated () const;
+  /**
+   * Set the Bearer Contexts
+   * \param bearerContexts a list of Bearer Contexts
+   */
   void SetBearerContextsCreated (std::list<BearerContextCreated> bearerContexts);
 
 private:
-  Cause_t m_cause;
-  GtpcHeader::Fteid_t m_senderCpFteid;
-
+  Cause_t m_cause; //!< Cause
+  GtpcHeader::Fteid_t m_senderCpFteid; //!< Sender CpFteid
+  /// Container of Bearer Contexts
   std::list<BearerContextCreated> m_bearerContextsCreated;
 };
 
 
+/**
+ * \ingroup lte
+ * GTP-C Modify Bearer Request Message
+ */
 class GtpcModifyBearerRequestMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -334,29 +531,60 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the IMSI
+   * \return IMSI
+   */
   uint64_t GetImsi () const;
+  /**
+   * Set the IMSI
+   * \param imsi IMSI
+   */
   void SetImsi (uint64_t imsi);
 
+  /**
+   * Get the UliEcgi
+   * \return UliEcgi
+   */
   uint32_t GetUliEcgi () const;
+  /**
+   * Set the UliEcgi
+   * \param uliEcgi UliEcgi
+   */
   void SetUliEcgi (uint32_t uliEcgi);
 
+  /**
+   * Bearer Context structure
+   */
   struct BearerContextToBeModified
   {
     uint8_t epsBearerId; ///< EPS bearer ID
     GtpcHeader::Fteid_t fteid; ///< FTEID
   };
 
+  /**
+   * Get the Bearer Contexts
+   * \return the Bearer Context list
+   */
   std::list<BearerContextToBeModified> GetBearerContextsToBeModified () const;
+  /**
+   * Set the Bearer Contexts
+   * \param bearerContexts the Bearer Context list
+   */
   void SetBearerContextsToBeModified (std::list<BearerContextToBeModified> bearerContexts);
 
 private:
-  uint64_t m_imsi;
-  uint32_t m_uliEcgi;
+  uint64_t m_imsi;     //!< IMSI
+  uint32_t m_uliEcgi;  //!< UliEcgi
 
+  /// Bearer Context list
   std::list<BearerContextToBeModified> m_bearerContextsToBeModified;
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Modify Bearer Response Message
+ */
 class GtpcModifyBearerResponseMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -374,14 +602,25 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the Cause
+   * \return the Cause
+   */
   Cause_t GetCause () const;
+  /**
+   * Set the Cause
+   * \param cause The cause
+   */
   void SetCause (Cause_t cause);
 
 private:
-  Cause_t m_cause;
+  Cause_t m_cause; //!< Cause
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Delete Bearer Command Message
+ */
 class GtpcDeleteBearerCommandMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -399,19 +638,31 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /// Bearer context
   struct BearerContext
   {
     uint8_t m_epsBearerId; ///< EPS bearer ID
   };
 
+  /**
+   * Get the Bearer contexts
+   * \return container of beraer contexts
+   */
   std::list<BearerContext> GetBearerContexts () const;
+  /**
+   * Set the Bearer contexts
+   * \param bearerContexts container of beraer contexts
+   */
   void SetBearerContexts (std::list<BearerContext> bearerContexts);
 
 private:
-  std::list<BearerContext> m_bearerContexts;
+  std::list<BearerContext> m_bearerContexts; //!< Container of Bearer Contexts
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Delete Bearer Request Message
+ */
 class GtpcDeleteBearerRequestMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -429,14 +680,25 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the Bearers IDs
+   * \return a container of Bearers IDs
+   */
   std::list<uint8_t> GetEpsBearerIds () const;
+  /**
+   * Set the Bearers IDs
+   * \param epsBearerIds The container of Bearers IDs
+   */
   void SetEpsBearerIds (std::list<uint8_t> epsBearerIds);
 
 private:
-  std::list<uint8_t> m_epsBearerIds;
+  std::list<uint8_t> m_epsBearerIds; //!< Container of Bearers IDs
 };
 
-
+/**
+ * \ingroup lte
+ * GTP-C Delete Bearer Response Message
+ */
 class GtpcDeleteBearerResponseMessage : public GtpcHeader, public GtpcIes
 {
 public:
@@ -454,15 +716,31 @@ public:
   virtual void Print (std::ostream &os) const;
   virtual uint32_t GetMessageSize (void) const;
 
+  /**
+   * Get the Cause
+   * \return the Cause
+   */
   Cause_t GetCause () const;
+  /**
+   * Set the Cause
+   * \param cause The cause
+   */
   void SetCause (Cause_t cause);
 
+  /**
+   * Get the Bearers IDs
+   * \return a container of Bearers IDs
+   */
   std::list<uint8_t> GetEpsBearerIds () const;
+  /**
+   * Set the Bearers IDs
+   * \param epsBearerIds The container of Bearers IDs
+   */
   void SetEpsBearerIds (std::list<uint8_t> epsBearerIds);
 
 private:
-  Cause_t m_cause;
-  std::list<uint8_t> m_epsBearerIds;
+  Cause_t m_cause; //!< Cause
+  std::list<uint8_t> m_epsBearerIds; //!< Container of Bearers IDs
 };
 
 } // namespace ns3

src/mpi/model/null-message-simulator-impl.h

@@ -134,6 +134,7 @@ private:
    * Get the current SafeTime; the maximum time that events can
    * be processed based on information received from neighboring
    * MPI tasks.
+   * \return the current SafeTime
    */
   Time GetSafeTime (void);
 

src/network/utils/bit-deserializer.h

@@ -71,6 +71,7 @@ public:
    * The maximum number of bits to be deserialized in one single call is 64.
    *
    * \param size The number of bits to pop.
+   * \return The popped bits value
    */
   uint64_t GetBits (uint8_t size);
 

src/propagation/model/three-gpp-propagation-loss-model.cc

@@ -32,7 +32,7 @@ namespace ns3 {
 
 NS_LOG_COMPONENT_DEFINE ("ThreeGppPropagationLossModel");
 
-static const double M_C = 3.0e8; // propagation velocity in free space
+static const double M_C = 3.0e8; //!< propagation velocity in free space
 
 // ------------------------------------------------------------------------- //
 

src/tap-bridge/model/tap-bridge.h

@@ -271,6 +271,8 @@ private:
 
   /**
    * Callback to process packets that are read
+   * \param buf input buffer
+   * \param len input buffer length
    */
   void ReadCallback (uint8_t *buf, ssize_t len);
 

src/traffic-control/model/cobalt-queue-disc.cc

@@ -129,16 +129,6 @@ static inline uint32_t ReciprocalDivide (uint32_t A, uint32_t R)
   return (uint32_t)(((uint64_t)A * R) >> 32);
 }
 
-double min (double x, double y)
-{
-  return (x < y) ? x : y;
-}
-
-double max (double x, double y)
-{
-  return (x > y) ? x : y;
-}
-
 /**
  * Returns the current time translated in CoDel time representation
  * \return the current time
@@ -408,7 +398,7 @@ void CobaltQueueDisc::CobaltQueueFull (int64_t now)
   if (CoDelTimeAfter ((now - m_lastUpdateTimeBlue), Time2CoDel (m_target)))
     {
       NS_LOG_LOGIC ("inside IF block");
-      m_pDrop = min (m_pDrop + m_increment, (double)1.0);
+      m_pDrop = std::min (m_pDrop + m_increment, (double)1.0);
       m_lastUpdateTimeBlue = now;
     }
   m_dropping = true;
@@ -425,7 +415,7 @@ void CobaltQueueDisc::CobaltQueueEmpty (int64_t now)
   NS_LOG_FUNCTION (this);
   if (m_pDrop && CoDelTimeAfter ((now - m_lastUpdateTimeBlue), Time2CoDel (m_target)))
     {
-      m_pDrop = max (m_pDrop - m_decrement, (double)0.0);
+      m_pDrop = std::max (m_pDrop - m_decrement, (double)0.0);
       m_lastUpdateTimeBlue = now;
     }
   m_dropping = false;
@@ -501,7 +491,7 @@ bool CobaltQueueDisc::CobaltShouldDrop (Ptr<QueueDiscItem> item, int64_t now)
       isMarked = (m_useEcn && Mark (item, FORCED_MARK));
       drop = !isMarked;
 
-      m_count = max (m_count, m_count + 1);
+      m_count = std::max (m_count, m_count + 1);
 
       InvSqrt ();
       m_dropNext = ControlLaw (m_dropNext);
@@ -530,7 +520,7 @@ bool CobaltQueueDisc::CobaltShouldDrop (Ptr<QueueDiscItem> item, int64_t now)
   // Enable Blue Enhancement if sojourn time is greater than blueThreshold and its been m_target time until the last time blue was updated
   if (CoDelTimeAfter (sojournTime, Time2CoDel (m_blueThreshold)) && CoDelTimeAfter ((now - m_lastUpdateTimeBlue), Time2CoDel (m_target)))
     {
-      m_pDrop = min (m_pDrop + m_increment, (double)1.0);
+      m_pDrop = std::min (m_pDrop + m_increment, (double)1.0);
       m_lastUpdateTimeBlue = now;
     }
 

src/traffic-control/model/cobalt-queue-disc.h

@@ -165,6 +165,9 @@ private:
    */
   int64_t ControlLaw (int64_t t);
 
+  /**
+   * \brief Updates the inverse square root
+   */
   void InvSqrt (void);
 
   /**
@@ -210,7 +213,8 @@ private:
 
   /**
    * Called to decide whether the current packet should be dropped based on decisions taken by Blue and Codel working parallely
-   * Returns true if the packet should be dropped, false otherwise
+   *
+   * \return true if the packet should be dropped, false otherwise
    * \param item current packet
    * \param now time in CoDel time units (microseconds)
    */

src/traffic-control/model/prio-queue-disc.h

@@ -26,6 +26,7 @@
 
 namespace ns3 {
 
+/// Priority map
 typedef std::array<uint16_t, 16> Priomap;
 
 /**
@@ -106,6 +107,7 @@ std::ostream &operator << (std::ostream &os, const Priomap &priomap);
  */
 std::istream &operator >> (std::istream &is, Priomap &priomap);
 
+
 ATTRIBUTE_HELPER_HEADER (Priomap);
 
 } // namespace ns3

src/wifi/model/wifi-ppdu.h

@@ -107,7 +107,6 @@ public:
    * Get the channel width over which the PPDU will effectively be
    * transmitted.
    *
-   * \param ppdu the PPDU to send
    * \return the effective channel width (in MHz) used for the tranmsission
    */
   virtual uint16_t GetTransmissionChannelWidth (void) const;
@@ -117,7 +116,6 @@ public:
    * channel. Normally, a PPDU can be received if it is transmitted over a
    * channel that overlaps the primary20 channel of a PHY entity.
    *
-   * \param ppdu the given PPDU
    * \param txCenterFreq the center frequency (MHz) of the channel over which the
    *        PPDU is transmitted
    * \param p20MinFreq the minimum frequency (MHz) of the primary channel

utils/grid.py

@@ -21,7 +21,6 @@ class DataRange:
         @param start start
         @param end end
         @param value value
-        @return none
         """
         self.start = start
         self.end = end
@@ -37,7 +36,6 @@ class EventString:
         @param self this object
         @param at you
         @param value value
-        @return none
         """
         self.at = at
         self.value = value
@@ -52,7 +50,6 @@ class EventFloat:
         @param self this object
         @param at you
         @param value value
-        @return none
         """
         self.at = at
         self.value = value
@@ -67,7 +64,6 @@ class EventInt:
         @param self this object
         @param at you
         @param value value
-        @return none
         """
         self.at = at
         self.value = value
@@ -97,7 +93,6 @@ class TimelineDataRange:
         """! Initializer
         @param self this object
         @param name name
-        @return none
         """
         self.name = name
         self.ranges = []
@@ -194,7 +189,6 @@ class TimelineEvent:
         """! Get ranges bounds
         @param self this object
         @param name name
-        @return none
         """
         self.name = name
         self.events = []
@@ -275,7 +269,6 @@ class Timeline:
         """! Initializer
         @param self this object
         @param name name
-        @return none
         """
         self.ranges = []
         self.event_str = []
@@ -447,7 +440,6 @@ class Color:
         @param r: red
         @param g: green
         @param b: blue
-        @return none
         """
         self.r = r
         self.g = g
@@ -475,7 +467,6 @@ class Colors:
     def __init__(self):
         """! Initializer
         @param self this object
-        @return none
         """
         self.__colors = {}
     def add(self, name, color):
@@ -511,7 +502,6 @@ class TopLegendRenderer:
     def __init__(self):
         """! Initializer
         @param self this object
-        @return none
         """
         self.__padding = 10
     def set_padding(self, padding):
@@ -627,7 +617,6 @@ class TimelinesRenderer:
     def __init__(self):
         """! Initializer
         @param self this object
-        @return none
         """
         self.padding = 10
         return
@@ -863,7 +852,6 @@ class ScaleRenderer:
     def __init__(self):
         """! Initializer
         @param self this object
-        @return none
         """
         self.__top = 0
         return
@@ -1007,7 +995,6 @@ class GraphicRenderer:
         @param self this object
         @param start start
         @param end end
-        @return none
         """
         self.__start = float(start)
         self.__end = float(end)
@@ -1301,7 +1288,6 @@ class GtkGraphicRenderer(gtk.DrawingArea):
         """! Initializer
         @param self this object
         @param data data
-        @return none
         """
         super(GtkGraphicRenderer, self).__init__()
         self.__data = data
@@ -1542,7 +1528,6 @@ class MainWindow:
     def __init__(self):
         """! Initializer
         @param self this object
-        @return none
         """
         return
     def run(self, graphic):

utils/print-introspected-doxygen.cc

@@ -1053,7 +1053,7 @@ PrintAllAttributes (std::ostream & os)
   os << commentStart << page << "AttributeList All Attributes\n"
      << std::endl;
   os << "This is a list of all" << reference << "ns3::Attribute classes.  "
-     << "For more information see the" << reference << "ns3:Attributes "
+     << "For more information see the" << reference << "ns3::Attributes "
      << "section of this API documentation and the Attributes sections "
      << "in the Tutorial and Manual.\n"
      << std::endl;
@@ -1524,6 +1524,8 @@ PrintAttributeImplementations (std::ostream & os)
       { "OrganizationIdentifier",
                           "OrganizationIdentifier",
                                             true,  "vendor-specific-action.h" },
+      { "Priomap",        "Priomap",        true,  "prio-queue-disc.h"  },
+      { "QueueSize",      "QueueSize",      true,  "queue-size.h"       },
       { "Rectangle",      "Rectangle",      true,  "rectangle.h"        },
       { "Ssid",           "Ssid",           true,  "ssid.h"             },
       { "TypeId",         "TypeId",         true,  "type-id.h"          },

utils/tests/TestBase.py

@@ -70,7 +70,6 @@ class TestBaseClass:
         @param argv argument list
         @param desc description
         @param mode test mode
-        @return none
         """
         self.my_env = os.environ
         set_workdir()