Fix Doxygen formatting

doc/manual/source/documentation.rst

@@ -555,7 +555,7 @@ usage for |ns3|.
      *  \ingroup foo
      *
      *  FooBar packet type.
-    */
+     */
     class FooBar
 
 * Did you know ``typedefs`` can have formal arguments?  This enables

examples/wireless/wifi-hidden-terminal.cc

@@ -125,7 +125,8 @@ experiment(bool enableCtsRts, std::string wifiManager)
     cbrApps.Add(onOffHelper.Install(nodes.Get(0)));
 
     // flow 2:  node 2 -> node 1
-    /** \internal
+    /**
+     * \internal
      * The slightly different start times and data rates are a workaround
      * for \bugid{388} and \bugid{912}
      */
@@ -133,7 +134,8 @@ experiment(bool enableCtsRts, std::string wifiManager)
     onOffHelper.SetAttribute("StartTime", TimeValue(Seconds(1.001)));
     cbrApps.Add(onOffHelper.Install(nodes.Get(2)));
 
-    /** \internal
+    /**
+     * \internal
      * We also use separate UDP applications that will send a single
      * packet before the CBR flows start.
      * This is a workaround for the lack of perfect ARP, see \bugid{187}

src/antenna/model/circular-aperture-antenna-model.cc

@@ -33,9 +33,9 @@
 #include <math.h>
 
 /**
- *  \file
- *  \ingroup antenna
- *  Class CircularApertureAntennaModel implementation.
+ * \file
+ * \ingroup antenna
+ * Class CircularApertureAntennaModel implementation.
  */
 
 namespace

src/aodv/model/aodv-rtable.h

@@ -84,7 +84,7 @@ class RoutingTableEntry
 
     ~RoutingTableEntry();
 
-    ///\name Precursors management
+    /// \name Precursors management
     //\{
     /**
      * Insert precursor in precursor list if it doesn't yet exist in the list
@@ -429,7 +429,7 @@ class RoutingTable
      */
     RoutingTable(Time t);
 
-    ///\name Handle lifetime of invalid route
+    /// \name Handle lifetime of invalid route
     //\{
     /**
      * Get the lifetime of a bad link

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

@@ -39,7 +39,7 @@ class Kun2600MhzPropagationLossModel;
  * \ingroup buildings
  * \ingroup propagation
  *
- *  \brief The HybridBuildingsPropagationModel is a compound of different models able to evaluate
+ * \brief The HybridBuildingsPropagationModel is a compound of different models able to evaluate
  * the pathloss from 200 to 2600 MHz, in different environments and with buildings (i.e., indoor and
  * outdoor communications).
  *

src/core/model/command-line.h

@@ -466,7 +466,7 @@ class CommandLine
 
     /**
      * \ingroup commandline
-     *\brief An argument Item assigning to POD
+     * \brief An argument Item assigning to POD
      */
     template <typename T>
     class UserItem : public Item
@@ -672,8 +672,9 @@ class CommandLine
 
 }; // class CommandLine
 
-/** \ingroup commandline
- *  \defgroup commandlinehelper Helpers to specialize UserItem
+/**
+ * \ingroup commandline
+ * \defgroup commandlinehelper Helpers to specialize UserItem
  */
 /**
  * \ingroup commandlinehelper

src/core/model/hash-function.h

@@ -42,9 +42,9 @@ namespace Hash
 {
 
 /**
- *  \ingroup hash
+ * \ingroup hash
  *
- *  \brief Hash function implementation base class.
+ * \brief Hash function implementation base class.
  */
 class Implementation : public SimpleRefCount<Implementation>
 {

src/core/model/hash.h

@@ -41,7 +41,7 @@ namespace ns3
  * \ingroup core
  * \defgroup hash Hash Functions
  *
- *  \brief Generic Hash function interface.
+ * \brief Generic Hash function interface.
  *
  * See \ref Hasher for main entry point.
  * See \ref hash-example.cc for example usage.

src/core/model/log.cc

@@ -492,8 +492,9 @@ void
 LogSetTimePrinter(TimePrinter printer)
 {
     g_logTimePrinter = printer;
-    /** \internal
-     *  This is the only place where we are more or less sure that all log variables
+    /**
+     * \internal
+     * This is the only place where we are more or less sure that all log variables
      * are registered. See \bugid{1082} for details.
      */
     CheckEnvironmentVariables();

src/core/model/log.h

@@ -195,7 +195,7 @@ void LogComponentDisableAll(LogLevel level);
  *   using ns3::g_log;
  *
  *   // Further definitions outside of the ns3 namespace
- *\endcode
+ * \endcode
  *
  * \param [in] name The log component name.
  */

src/core/model/matrix-array.h

@@ -200,7 +200,7 @@ class MatrixArray : public ValArray<T>
      */
     MatrixArray FrobeniusNorm() const;
     /**
-     *\brief Multiply each matrix in the array by the left and the right matrix.
+     * \brief Multiply each matrix in the array by the left and the right matrix.
      * For each page of this MatrixArray the operation performed is
      * lMatrix * matrix(pageIndex) * rMatrix, and the resulting MatrixArray<T>
      * contains the array of the results per page. If "this" has dimensions

src/core/model/simulator-impl.h

@@ -54,7 +54,7 @@ class SimulatorImpl : public Object
      */
     static TypeId GetTypeId();
 
-    /**  \copydoc Simulator::Destroy   */
+    /** \copydoc Simulator::Destroy */
     virtual void Destroy() = 0;
     /** \copydoc Simulator::IsFinished */
     virtual bool IsFinished() const = 0;

src/core/model/vector.h

@@ -394,25 +394,25 @@ Ptr<const AttributeChecker> MakeVectorChecker();
 
 // Document these by hand so they go in group attribute_Vector3D
 
-/*!
-\ingroup attribute_Vector3D
-\fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1)
-\copydoc ns3::MakeAccessorHelper(T1)
-\see AttributeAccessor
-*/
+/**
+ * \ingroup attribute_Vector3D
+ * \fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1)
+ * \copydoc ns3::MakeAccessorHelper(T1)
+ * \see AttributeAccessor
+ */
 
-/*!
-\ingroup attribute_Vector3D
-\fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1, T2 a2)
-\copydoc ns3::MakeAccessorHelper(T1,T2)
-\see AttributeAccessor
-*/
+/**
+ * \ingroup attribute_Vector3D
+ * \fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1, T2 a2)
+ * \copydoc ns3::MakeAccessorHelper(T1,T2)
+ * \see AttributeAccessor
+ */
 
-/*!
-\ingroup attribute_Vector3D
-\fn ns3::Ptr<const ns3::AttributeChecker> ns3::MakeVectorChecker ()
-\returns The AttributeChecker.
-\see AttributeChecker
-*/
+/**
+ * \ingroup attribute_Vector3D
+ * \fn ns3::Ptr<const ns3::AttributeChecker> ns3::MakeVectorChecker ()
+ * \returns The AttributeChecker.
+ * \see AttributeChecker
+ */
 
 #endif /* NS3_VECTOR_H */

src/core/model/version-defines.h.in

@@ -1,4 +1,3 @@
-/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
  * Copyright (c) 2018 Lawrence Livermore National Laboratory
  *
@@ -22,16 +21,16 @@
 #define NS3_VERSION_DEFINES_H_
 
 /**
-  * \file
-  * \ingroup buildversion
-  * Defines the macro values for printing the build version.
-  * These will be populated by the build system.
-  */
+ * \file
+ * \ingroup buildversion
+ * Defines the macro values for printing the build version.
+ * These will be populated by the build system.
+ */
 
 /**
-  * \ingroup buildversion
-  * @{
-  */
+ * \ingroup buildversion
+ * @{
+ */
 
 /**
  * The first tag found which matches the pattern ns-3*.

src/internet/model/ipv4-route.h

@@ -33,7 +33,7 @@ class NetDevice;
 /**
  * \ingroup ipv4Routing
  *
- *\brief IPv4 route cache entry (similar to Linux struct rtable)
+ * \brief IPv4 route cache entry (similar to Linux struct rtable)
  *
  * This is a reference counted object.  In the future, we will add other
  * entries from struct dst_entry, struct rtable, and struct dst_ops as needed.

src/internet/model/tcp-ledbat.h

@@ -126,7 +126,7 @@ class TcpLedbat : public TcpNewReno
 
   private:
     /**
-     *\brief Buffer structure to store delays
+     * \brief Buffer structure to store delays
      */
     struct OwdCircBuf
     {

src/internet/model/tcp-socket-base.h

@@ -1145,7 +1145,8 @@ class TcpSocketBase : public TcpSocket
      */
     void DoRetransmit();
 
-    /** \brief Add options to TcpHeader
+    /**
+     * \brief Add options to TcpHeader
      *
      * Test each option, and if it is enabled on our side, add it
      * to the header
@@ -1232,7 +1233,8 @@ class TcpSocketBase : public TcpSocket
      */
     void AddOptionSack(TcpHeader& header);
 
-    /** \brief Process the timestamp option from other side
+    /**
+     * \brief Process the timestamp option from other side
      *
      * Get the timestamp and the echo, then save timestamp (which will
      * be the echo value in our out-packets) and save the echoed timestamp,

src/internet/model/tcp-tx-buffer.h

@@ -499,7 +499,7 @@ class TcpTxBuffer : public Object
      * The cases we need to manage are two, and they are depicted in the following
      * image:
      *
-     *\verbatim
+     * \verbatim
                          |------|     |----|     |----|
                   list = |      | --> |    | --> |    |
                          |------|     |----|     |----|
@@ -525,7 +525,7 @@ class TcpTxBuffer : public Object
      * and we reduce case (2) to case (1) through sequentially applying fragment
      * or merge. For instance:
      *
-     *\verbatim
+     * \verbatim
         |------|
         |      |
         |------|

src/internet/test/tcp-advertised-window-test.cc

@@ -303,7 +303,8 @@ class TcpAdvertisedWindowTest : public TcpGeneralTest
     Ptr<ErrorModel> CreateReceiverErrorModel() override;
 
   private:
-    /** \brief Callback called for the update of the awnd
+    /**
+     * \brief Callback called for the update of the awnd
      * \param oldAwnd Old advertised window
      * \param newAwnd new value
      */
@@ -389,7 +390,8 @@ class TcpAdvWindowOnLossTest : public TcpGeneralTest
     Ptr<ErrorModel> CreateReceiverErrorModel() override;
 
   private:
-    /** \brief Callback called for the update of the awnd
+    /**
+     * \brief Callback called for the update of the awnd
      * \param oldAwnd Old advertised window
      * \param newAwnd new value
      */

src/internet/test/tcp-general-test.h

@@ -759,7 +759,7 @@ class TcpGeneralTest : public TestCase
     }
 
     /**
-     *  \brief Slow start threshold changes
+     * \brief Slow start threshold changes
      *
      * This applies only for sender socket.
      *

src/internet/test/tcp-ledbat-test.cc

@@ -60,7 +60,8 @@ class TcpLedbatToNewReno : public TestCase
 
   private:
     void DoRun() override;
-    /** \brief Execute the test
+    /**
+     * \brief Execute the test
      */
     void ExecuteTest();
 
@@ -160,7 +161,8 @@ class TcpLedbatIncrementTest : public TestCase
 
   private:
     void DoRun() override;
-    /** \brief Execute the test
+    /**
+     * \brief Execute the test
      */
     void ExecuteTest();
 
@@ -261,7 +263,8 @@ class TcpLedbatDecrementTest : public TestCase
 
   private:
     void DoRun() override;
-    /** \brief Execute the test
+    /**
+     * \brief Execute the test
      */
     void ExecuteTest();
 

src/internet/test/tcp-sack-permitted-test.cc

@@ -198,7 +198,7 @@ SackPermittedTestCase::Tx(const Ptr<const Packet> p, const TcpHeader& h, SocketW
 
 /**
  * \ingroup internet-test
- *  \ingroup tests
+ * \ingroup tests
  *
  * The test case for testing the TCP SACK PERMITTED option.
  */

src/lr-wpan/model/lr-wpan-mac-base.h

@@ -880,7 +880,7 @@ class LrWpanMacBase : public Object
      * The callback implements MLME-GET.confirm SAP of IEEE 802.15.4-2011,
      * section 6.2.5.2
      *
-     *\param c the callback
+     * \param c the callback
      */
     void SetMlmeGetConfirmCallback(MlmeGetConfirmCallback c);
 

src/lr-wpan/model/lr-wpan-mac.h

@@ -668,14 +668,14 @@ class LrWpanMac : public LrWpanMacBase
     /**
      * Check if the packet destination is its coordinator
      *
-     *\param mac The coordinator short MAC Address
+     * \param mac The coordinator short MAC Address
      */
     void SetAssociatedCoor(Mac16Address mac);
 
     /**
      * Check if the packet destination is its coordinator
      *
-     *\param mac The coordinator extended MAC Address
+     * \param mac The coordinator extended MAC Address
      */
     void SetAssociatedCoor(Mac64Address mac);
 
@@ -689,15 +689,15 @@ class LrWpanMac : public LrWpanMacBase
     /**
      * Obtain the number of symbols in the packet which is currently being sent by the MAC layer.
      *
-     *\return packet number of symbols
-     * */
+     * \return packet number of symbols
+     */
     uint64_t GetTxPacketSymbols();
 
     /**
      * Check if the packet to transmit requires acknowledgment
      *
-     *\return True if the Tx packet requires acknowledgment
-     * */
+     * \return True if the Tx packet requires acknowledgment
+     */
     bool IsTxAckReq();
 
     /**

src/lte/model/lte-enb-rrc.h

@@ -1045,7 +1045,7 @@ class LteEnbRrc : public Object
     void SendHandoverRequest(uint16_t rnti, uint16_t cellId);
 
     /**
-     *  \brief This function acts as an interface to trigger Release indication messages towards eNB
+     * \brief This function acts as an interface to trigger Release indication messages towards eNB
      * and EPC
      * \param imsi the IMSI
      * \param rnti the RNTI

src/mesh/model/dot11s/hwmp-protocol.h

@@ -165,7 +165,7 @@ class HwmpProtocol : public MeshL2RoutingProtocol
      *  \param os the output stream
      */
     void Report(std::ostream& os) const;
-    ///\brief Reset Statistics:
+    /// \brief Reset Statistics:
     void ResetStats();
     ///@}
 
@@ -412,7 +412,7 @@ class HwmpProtocol : public MeshL2RoutingProtocol
     void SendProactivePreq();
     ///@}
 
-    ///\return address of MeshPointDevice
+    /// \return address of MeshPointDevice
     Mac48Address GetAddress();
     /// \name Methods needed by HwmpMacLugin to access protocol parameters:
     ///@{

src/mesh/model/dot11s/peer-link-frame.h

@@ -53,7 +53,7 @@ class PeerLinkOpenStart : public Header
     PeerLinkOpenStart(const PeerLinkOpenStart&) = delete;
     PeerLinkOpenStart& operator=(const PeerLinkOpenStart&) = delete;
 
-    ///\brief fields:
+    /// \brief fields:
     struct PlinkOpenStartFields
     {
         IePeeringProtocol protocol; ///< Peering protocol version - 3 octets
@@ -123,7 +123,7 @@ class PeerLinkCloseStart : public Header
     PeerLinkCloseStart(const PeerLinkCloseStart&) = delete;
     PeerLinkCloseStart& operator=(const PeerLinkCloseStart&) = delete;
 
-    ///\brief fields:
+    /// \brief fields:
     struct PlinkCloseStartFields
     {
         IePeeringProtocol protocol; ///< Peering protocol version - 3 octets
@@ -187,7 +187,7 @@ class PeerLinkConfirmStart : public Header
     PeerLinkConfirmStart(const PeerLinkConfirmStart&) = delete;
     PeerLinkConfirmStart& operator=(const PeerLinkConfirmStart&) = delete;
 
-    ///\brief fields:
+    /// \brief fields:
     struct PlinkConfirmStartFields
     {
         IePeeringProtocol protocol; ///< Peering protocol version - 3 octets

src/mesh/model/dot11s/peer-management-protocol-mac.h

@@ -129,7 +129,7 @@ class PeerManagementProtocolMac : public MeshWifiInterfaceMacPlugin
     /// allow PeerLink class access friend access
     friend class PeerLink;
 
-    ///\name Create peer link management frames
+    /// \name Create peer link management frames
     // \{
     /**
      * \brief This structure keeps all fields in peer link management frame,
@@ -234,7 +234,7 @@ class PeerManagementProtocolMac : public MeshWifiInterfaceMacPlugin
 
   private:
     Statistics m_stats; ///< statistics
-    ///\name Information about MAC and protocol:
+    /// \name Information about MAC and protocol:
     Ptr<MeshWifiInterfaceMac> m_parent;     ///< parent
     uint32_t m_ifIndex;                     ///< IF index
     Ptr<PeerManagementProtocol> m_protocol; ///< protocol

src/mesh/model/dot11s/peer-management-protocol.h

@@ -263,9 +263,9 @@ class PeerManagementProtocol : public Object
     typedef std::map<uint32_t, PeerLinksOnInterface> PeerLinksMap;
     /// This map keeps relationship between peer address and its beacon information
     typedef std::map<Mac48Address, BeaconInfo> BeaconsOnInterface;
-    ///\brief This map keeps beacon information on all interfaces
+    /// \brief This map keeps beacon information on all interfaces
     typedef std::map<uint32_t, BeaconsOnInterface> BeaconInfoMap;
-    ///\brief this vector keeps pointers to MAC-plugins
+    /// \brief this vector keeps pointers to MAC-plugins
     typedef std::map<uint32_t, Ptr<PeerManagementProtocolMac>> PeerManagementProtocolMacMap;
 
     /**

src/network/utils/ethernet-trailer.h

@@ -86,7 +86,7 @@ class EthernetTrailer : public Trailer
     bool CheckFcs(Ptr<const Packet> p) const;
 
     /**
-     *\return Returns the size of the trailer
+     * \return Returns the size of the trailer
      */
     uint32_t GetTrailerSize() const;
 

src/sixlowpan/model/sixlowpan-header.h

@@ -46,8 +46,8 @@ class SixLowPanDispatch
 {
   public:
     /**
-     *  \brief Dispatch values, as defined in \RFC{4944} and \RFC{6282}
-    \verbatim
+     * \brief Dispatch values, as defined in \RFC{4944} and \RFC{6282}
+     \verbatim
        Pattern    Header Type
      +------------+------------------------------------------------+
      | 00  xxxxxx | NALP        - Not a LoWPAN frame               |

src/wifi/model/ht/ht-operation.h

@@ -318,7 +318,7 @@ class HtOperation : public WifiInformationElement
      * Return MCS is supported.
      *
      * \param mcs MCS
-     *\
+     *
      * \return the MCS is supported
      */
     bool IsSupportedMcs(uint8_t mcs) const;

src/wimax/model/service-flow-manager.h

@@ -111,13 +111,13 @@ class ServiceFlowManager : public Object
     uint32_t GetNrServiceFlows() const;
 
     /**
-     *\param SrcAddress the source ip address
-     *\param DstAddress the destination ip address
-     *\param SrcPort the source port
-     *\param DstPort the destination port
-     *\param Proto the protocol
-     *\param dir the direction of the service flow
-     *\return the service flow to which this ip flow is associated
+     * \param SrcAddress the source ip address
+     * \param DstAddress the destination ip address
+     * \param SrcPort the source port
+     * \param DstPort the destination port
+     * \param Proto the protocol
+     * \param dir the direction of the service flow
+     * \return the service flow to which this ip flow is associated
      */
     ServiceFlow* DoClassify(Ipv4Address SrcAddress,
                             Ipv4Address DstAddress,