group wimax classes in doxygen

src/wimax/model/bandwidth-manager.h

@@ -41,6 +41,7 @@ class UlJob;
 class UplinkScheduler;
 
 /**
+ * \ingroup wimax
  * \brief This class manage the bandwidth request and grant mechanism.
  * The bandwidth request and grant mechanism is supported by the Bandwidth
  * Manager. Both BS and SS maintain a bandwidth manager. Furthermore BS's

src/wimax/model/bs-link-manager.h

@@ -32,6 +32,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class BSLinkManager : public Object
 {
 public:

src/wimax/model/bs-net-device.h

@@ -44,6 +44,9 @@ class BSLinkManager;
 class UplinkScheduler;
 class BsServiceFlowManager;
 
+/**
+ * \ingroup wimax
+ */
 class BaseStationNetDevice : public WimaxNetDevice
 {
 public:

src/wimax/model/bs-scheduler-rtps.h

@@ -39,6 +39,7 @@ class WimaxConnection;
 class Cid;
 
 /**
+ * \ingroup wimax
  * \brief This class implements a simple downlink scheduler for rtPS flows.
  *
  * The DL-rtPS-Scheduler assigns the available bandwidth the service flows

src/wimax/model/bs-scheduler-simple.h

@@ -37,6 +37,9 @@ class GenericMacHeader;
 class WimaxConnection;
 class Cid;
 
+/**
+ * \ingroup wimax
+ */
 class BSSchedulerSimple : public BSScheduler
 {
 public:

src/wimax/model/bs-scheduler.h

@@ -37,6 +37,9 @@ class GenericMacHeader;
 class WimaxConnection;
 class Cid;
 
+/**
+ * \ingroup wimax
+ */
 class BSScheduler : public Object
 {
 public:

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

@@ -37,6 +37,9 @@ class SSRecord;
 class WimaxConnection;
 class BaseStationNetDevice;
 
+/**
+ * \ingroup wimax
+ */
 class BsServiceFlowManager : public ServiceFlowManager
 {
 public:

src/wimax/model/bs-uplink-scheduler-mbqos.h

@@ -42,6 +42,7 @@ class ServiceFlowRecord;
 class UlJob;
 
 /**
+ * \ingroup wimax
  * \brief This class implements a Migration-based Quality of Service uplink scheduler(MBQoS).
  *
  * This uplink scheduler uses three queues, the low priority

src/wimax/model/bs-uplink-scheduler-rtps.h

@@ -34,6 +34,7 @@ class SSRecord;
 class ServiceFlow;
 
 /**
+ * \ingroup wimax
  * \brief This class implements a simple uplink scheduler for rtPS flows.
  *
  * The UL-rtPS-Scheduler work in this way:

src/wimax/model/bs-uplink-scheduler-simple.h

@@ -34,6 +34,9 @@ class BaseStationNetDevice;
 class SSRecord;
 class ServiceFlow;
 
+/**
+ * \ingroup wimax
+ */
 class UplinkSchedulerSimple : public UplinkScheduler
 {
 public:

src/wimax/model/bs-uplink-scheduler.h

@@ -36,6 +36,7 @@ class ServiceFlow;
 class ServiceFlowRecord;
 
 /**
+ * \ingroup wimax
  * \brief Virtual class for uplink scheduler.
  */
 class UplinkScheduler : public Object

src/wimax/model/burst-profile-manager.h

@@ -31,6 +31,9 @@ namespace ns3 {
 class SSRecord;
 class RngReq;
 
+/**
+ * \ingroup wimax
+ */
 class BurstProfileManager : public Object
 {
 public:

src/wimax/model/cid-factory.h

@@ -30,6 +30,7 @@
 namespace ns3 {
 
 /**
+ * \ingroup wimax
  * This class is used exclusively by the BS to allocate CIDs to new connections.
  * This class uses the definitions from Table 345 in ieee-802.16-2004 to
  * allocate cids in different integer ranges according to their type.

src/wimax/model/cid.h

@@ -29,6 +29,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class Cid
 {
 public:

src/wimax/model/connection-manager.h

@@ -36,8 +36,9 @@ class RngRsp;
 class WimaxNetDevice;
 class SubscriberStationNetDevice;
 
-/*
- The same connection manager class serves both for BS and SS though some functions are exclusive to only one of them.
+/**
+ * \ingroup wimax
+ * The same connection manager class serves both for BS and SS though some functions are exclusive to only one of them.
  */
 
 class ConnectionManager : public Object

src/wimax/model/cs-parameters.h

@@ -26,6 +26,9 @@
 #define CSPARAMETERS_H_
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class CsParameters
 {
 public:

src/wimax/model/dl-mac-messages.h

@@ -29,14 +29,15 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ * \brief This class implements the DCD channel encodings as described by "IEEE Standard for
+ * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
+ * 11.4.1 DCD channel encodings, page 659
+ *
+  */
 class DcdChannelEncodings
 {
-  /**
-   * \brief This class implements the DCD channel encodings as described by "IEEE Standard for
-   * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
-   * 11.4.1 DCD channel encodings, page 659
-   *
-   */
 public:
   DcdChannelEncodings (void);
   virtual ~DcdChannelEncodings (void);

src/wimax/model/ipcs-classifier-record.h

@@ -28,6 +28,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class IpcsClassifierRecord
 {
 public:

src/wimax/model/ipcs-classifier.h

@@ -30,6 +30,9 @@
 namespace ns3 {
 class SsServiceFlowManager;
 
+/**
+ * \ingroup wimax
+ */
 class IpcsClassifier : public Object
 {
 public:

src/wimax/model/mac-messages.h

@@ -35,6 +35,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class ManagementMessageType : public Header
 {
 public:

src/wimax/model/ofdm-downlink-frame-prefix.h

@@ -27,10 +27,10 @@
 namespace ns3 {
 
 /**
+ * \ingroup wimax
  *\brief This class implements  the DL Frame Prefix IE as described by IEEE-802.16 standard
  *\brief The DL Frame Prefix IE is contained in DLFP (Downlink Frame Prefix) in OFDM PHY
  */
-
 class DlFramePrefixIe
 {
 public:

src/wimax/model/send-params.h

@@ -29,19 +29,19 @@ namespace ns3 {
 
 class WimaxPhy;
 
+/**
+ * \ingroup wimax
+ * \brief The SendParams class defines the parameters with which Send() function of
+ *  a particular PHY is called. The sole purpose of this class is to allow
+ *  defining the pure virtual Send() function in the PHY base-class (WimaxPhy).
+ *  This class shall be sub-classed every time a new PHY is integrated (i.e.,
+ *  a new sub-class of WimaxPhy is created) which requires different or
+ *  additional parameters to call its Send() function. For example as it is
+ *  seen here, it has been sub-classed for the OFDM PHY layer since its Send()
+ *  function requires two additional parameters.
+ */
 class SendParams
 {
-  /**
-   * \brief The SendParams class defines the parameters with which Send() function of
-   *  a particular PHY is called. The sole purpose of this class is to allow
-   *  defining the pure virtual Send() function in the PHY base-class (WimaxPhy).
-   *  This class shall be sub-classed every time a new PHY is integrated (i.e.,
-   *  a new sub-class of WimaxPhy is created) which requires different or
-   *  additional parameters to call its Send() function. For example as it is
-   *  seen here, it has been sub-classed for the OFDM PHY layer since its Send()
-   *  function requires two additional parameters.
-   */
-
 public:
   SendParams ();
   virtual ~SendParams ();

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

@@ -35,10 +35,10 @@ class WimaxNetDevice;
 class SSRecord;
 class WimaxConnection;
 
-/*
- The same service flow manager class serves both for BS and SS though some functions are exclusive to only one of them.
+/**
+ * \ingroup wimax
+ * The same service flow manager class serves both for BS and SS though some functions are exclusive to only one of them.
  */
-
 class ServiceFlowManager : public Object
 {
 public:

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

@@ -28,11 +28,13 @@
 #include "ns3/ptr.h"
 
 namespace ns3 {
+
+/**
+ * \ingroup wimax
+ * \brief this class implements a structure to manage some parameters and statistics related to a service flow
+ */
 class ServiceFlowRecord
 {
-  /**
-   * \brief this class implements a structure to manage some parameters and statistics related to a service flow
-   */
 public:
   ServiceFlowRecord (void);
   ~ServiceFlowRecord (void);

src/wimax/model/service-flow.h

@@ -32,11 +32,12 @@ namespace ns3 {
 class ServiceFlowRecord;
 class WimaxConnection;
 
-class ServiceFlow
-{
 /**
+ * \ingroup wimax
  * This class implements service flows as described by the IEEE-802.16 standard
  */
+class ServiceFlow
+{
 public:
   enum Direction
   {

src/wimax/model/simple-ofdm-send-param.h

@@ -29,6 +29,10 @@
 #define SIMPLEOFDMSENDPARAM_H_
 
 namespace ns3 {
+
+/**
+ * \ingroup wimax
+ */
 class simpleOfdmSendParam
 {
 public:

src/wimax/model/simple-ofdm-wimax-channel.h

@@ -35,6 +35,9 @@ class Packet;
 class PacketBurst;
 class SimpleOfdmWimaxPhy;
 
+/**
+ * \ingroup wimax
+ */
 class SimpleOfdmWimaxChannel : public WimaxChannel
 {
 public:

src/wimax/model/simple-ofdm-wimax-phy.h

@@ -39,6 +39,9 @@ class NetDevice;
 class Packet;
 class SimpleOfdmWimaxChannel;
 
+/**
+ * \ingroup wimax
+ */
 class SimpleOfdmWimaxPhy : public WimaxPhy
 {
 public:

src/wimax/model/snr-to-block-error-rate-manager.h

@@ -20,7 +20,17 @@
  */
 
 
+#ifndef SNRTOBLOCKERRORRATEMANAGER_H_
+#define SNRTOBLOCKERRORRATEMANAGER_H_
+
+#include "ns3/snr-to-block-error-rate-record.h"
+#include <vector>
+#include "ns3/ptr.h"
+
+namespace ns3 {
+
 /**
+ * \ingroup wimax
  * \brief This class handles the  SNR to BlcER traces.  A path to a repository containing trace files should be provided.
  * If no repository is provided the traces form default-traces.h will be loaded.
  * A valid repository should contain 7 files, one for each modulation and coding scheme.
@@ -33,15 +43,6 @@
  *  ...           ...       ...          ...                      ...                        ...
  * SNR_value(n)   BER(n)    Blc_ER(n)    STANDARD_DEVIATION(n)    CONFIDENCE_INTERVAL1(n)    CONFIDENCE_INTERVAL2(n)
  */
-#ifndef SNRTOBLOCKERRORRATEMANAGER_H_
-#define SNRTOBLOCKERRORRATEMANAGER_H_
-
-#include "ns3/snr-to-block-error-rate-record.h"
-#include <vector>
-#include "ns3/ptr.h"
-
-namespace ns3 {
-
 class SNRToBlockErrorRateManager
 {
 public:

src/wimax/model/snr-to-block-error-rate-record.h

@@ -19,17 +19,17 @@
  *                              <amine.ismail@udcast.com>
  */
 
+#ifndef SNRTOBLOCKERRORRATERECORD_H_
+#define SNRTOBLOCKERRORRATERECORD_H_
+namespace ns3 {
+
 /**
+ * \ingroup wimax
  * \brief This class represents a record (handled by SnrToBlockErrorRate manager) that keeps a mapping between
  * an SNR value and its corresponding (1) Bit Error Rate, (2) Block Error Rate, (3) Standard deviation, (4 and 5)
  * confidence interval.
  *
  */
-
-#ifndef SNRTOBLOCKERRORRATERECORD_H_
-#define SNRTOBLOCKERRORRATERECORD_H_
-namespace ns3 {
-
 class SNRToBlockErrorRateRecord
 {
 public:

src/wimax/model/ss-link-manager.h

@@ -33,12 +33,13 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ * \brief this class implements the link manager of subscriber station net device. An ss link manager is
+ * responsible for link scanning and ranging
+ */
 class SSLinkManager : public Object
 {
-  /**
-   * \brief this class implements the link manager of subscriber station net device. An ss link manager is
-   * responsible for link scanning and ranging
-   */
 public:
   SSLinkManager (Ptr<SubscriberStationNetDevice> ss);
   ~SSLinkManager (void);

src/wimax/model/ss-manager.h

@@ -29,12 +29,13 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ * \brief this class manages a list of SSrecord
+ * \see SSrecord
+ */
 class SSManager : public Object
 {
-  /**
-   * \brief this class manages a list of SSrecord
-   * \see SSrecord
-   */
 public:
   SSManager (void);
   ~SSManager (void);

src/wimax/model/ss-net-device.h

@@ -40,6 +40,10 @@ class SSScheduler;
 class SSLinkManager;
 class SsServiceFlowManager;
 class IpcsClassifier;
+
+/**
+ * \ingroup wimax
+ */
 class SubscriberStationNetDevice : public WimaxNetDevice
 {
 public:

src/wimax/model/ss-record.h

@@ -36,11 +36,12 @@ namespace ns3 {
 
 class ServiceFlow;
 
+/**
+ * \ingroup wimax
+ * \brief This class is used by the base station to store some information related to subscriber station in the cell.
+ */
 class SSRecord
 {
-  /**
-   * \brief This class is used by the base station to store some information related to subscriber station in the cell.
-   */
 public:
   SSRecord (void);
   SSRecord (Mac48Address macAddress);

src/wimax/model/ss-scheduler.h

@@ -34,6 +34,9 @@ namespace ns3 {
 class SubscriberStationNetDevice;
 class WimaxConnection;
 
+/**
+ * \ingroup wimax
+ */
 class SSScheduler : public Object
 {
 

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

@@ -36,6 +36,9 @@ class WimaxNetDevice;
 class WimaxConnection;
 class SubscriberStationNetDevice;
 
+/**
+ * \ingroup wimax
+ */
 class SsServiceFlowManager : public ServiceFlowManager
 {
 public:

src/wimax/model/ul-job.h

@@ -38,11 +38,12 @@ enum ReqType
   DATA, UNICAST_POLLING
 };
 
+/**
+ * \ingroup wimax
+ * \brief this class implements a structure to compute the priority of service flows
+ */
 class UlJob : public Object
 {
-  /**
-   * \brief this class implements a structure to compute the priority of service flows
-   */
 public:
   enum JobPriority
   {

src/wimax/model/ul-mac-messages.h

@@ -30,14 +30,15 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ * \brief This class implements the UCD channel encodings as described by "IEEE Standard for
+ * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
+ * 11.3.1 UCD channel encodings, page 651
+ *
+ */
 class UcdChannelEncodings
 {
-  /**
-   * \brief This class implements the UCD channel encodings as described by "IEEE Standard for
-   * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
-   * 11.3.1 UCD channel encodings, page 651
-   *
-   */
 public:
   UcdChannelEncodings (void);
   virtual ~UcdChannelEncodings (void);

src/wimax/model/wimax-channel.h

@@ -33,6 +33,9 @@ class Packet;
 class Position;
 class PacketBurst;
 
+/**
+ * \ingroup wimax
+ */
 class WimaxChannel : public Channel
 {
 public:

src/wimax/model/wimax-connection.h

@@ -35,6 +35,9 @@ namespace ns3 {
 class ServiceFlow;
 class Cid;
 
+/**
+ * \ingroup wimax
+ */
 class WimaxConnection : public Object
 {
 public:

src/wimax/model/wimax-mac-header.h

@@ -27,8 +27,10 @@
 
 namespace ns3 {
 
-/*Represents the HT (Header Type) field of generic MAC and bandwidth request headers*/
-
+/**
+ * \ingroup wimax
+ * \brief Represents the HT (Header Type) field of generic MAC and bandwidth request headers
+*/
 class MacHeaderType : public Header
 {
   /**

src/wimax/model/wimax-mac-queue.h

@@ -31,6 +31,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ */
 class WimaxMacQueue : public Object
 {
 public:

src/wimax/model/wimax-mac-to-mac-header.h

@@ -23,8 +23,11 @@
 
 #include <stdint.h>
 #include "ns3/header.h"
+
 namespace ns3 {
+
 /**
+ * \ingroup wimax
  * \brief this class implements the mac to mac header needed to dump a wimax pcap file
  * The header format was reverse-engineered by looking  at existing live pcap traces which
  * could be opened with wireshark  i.e., we have no idea where this is coming from.

src/wimax/model/wimax-phy.h

@@ -39,6 +39,9 @@ class WimaxNetDevice;
 class NetDevice;
 class Packet;
 
+/**
+ * \ingroup wimax
+ */
 class WimaxPhy : public Object
 {
 public:

src/wimax/model/wimax-tlv.h

@@ -35,12 +35,13 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup wimax
+ * \brief The value field of a tlv can take different values (uint8_t, uint16, vector...). This class is a virtual interface
+ * that all the types of tlv values should derive
+ */
 class TlvValue
 {
-  /**
-   * \brief The value field of a tlv can take different values (uint8_t, uint16, vector...). This class is a virtual interface
-   * that all the types of tlv values should derive
-   */
 public:
   virtual ~TlvValue ()
   {
@@ -54,15 +55,16 @@ private:
 
 
 // =============================================================================
+/**
+ * \ingroup wimax
+ * \brief This class implements the Type-Len-Value structure channel encodings as described by "IEEE Standard for
+ * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
+ * 11. TLV encodings, page 645
+ *
+ */
 class Tlv : public Header
 {
 public:
-  /**
-   * \brief This class implements the Type-Len-Value structure channel encodings as described by "IEEE Standard for
-   * Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems"
-   * 11. TLV encodings, page 645
-   *
-   */
   enum CommonTypes
   {
     HMAC_TUPLE = 149,
@@ -97,6 +99,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class U8TlvValue : public TlvValue
 {
 public:
@@ -114,6 +119,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class U16TlvValue : public TlvValue
 {
 public:
@@ -131,6 +139,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class U32TlvValue : public TlvValue
 {
 public:
@@ -150,11 +161,12 @@ private:
 
 // ==============================================================================
 
+/**
+ * \ingroup wimax
+ * \brief this class is used to implement a vector of values in one tlv value field
+ */
 class VectorTlvValue : public TlvValue
 {
-  /**
-   * \brief this class is used to implement a vector of values in one tlv value field
-   */
 public:
   typedef std::vector<Tlv*>::const_iterator Iterator;
   VectorTlvValue (void);
@@ -171,7 +183,9 @@ private:
 };
 
 // ==============================================================================
-
+/**
+ * \ingroup wimax
+ */
 class SfVectorTlvValue : public VectorTlvValue
 {
 
@@ -215,11 +229,12 @@ public:
 };
 // ==============================================================================
 
+/**
+ * \ingroup wimax
+ * \brief this class implements the convergence sub-layer descriptor as a tlv vector
+ */
 class CsParamVectorTlvValue : public VectorTlvValue
 {
-  /*
-   * \brief this class implements the convergence sub-layer descriptor as a tlv vector
-   */
 public:
   enum Type
   {
@@ -234,11 +249,12 @@ private:
 
 // ==============================================================================
 
+/**
+ * \ingroup wimax
+ * \brief this class implements the classifier descriptor as a tlv vector
+ */
 class ClassificationRuleVectorTlvValue : public VectorTlvValue
 {
-  /*
-   * \brief this class implements the classifier descriptor as a tlv vector
-   */
 public:
   enum ClassificationRuleTlvType
   {
@@ -258,6 +274,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class TosTlvValue : public TlvValue
 {
 public:
@@ -278,6 +297,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class PortRangeTlvValue : public TlvValue
 {
 public:
@@ -301,6 +323,9 @@ private:
 };
 
 // ==============================================================================
+/**
+ * \ingroup wimax
+ */
 class ProtocolTlvValue : public TlvValue
 {
 public:
@@ -320,6 +345,9 @@ private:
 
 // ==============================================================================
 
+/**
+ * \ingroup wimax
+ */
 class Ipv4AddressTlvValue : public TlvValue
 {
 public: