--- a/src/energy/helper/basic-energy-source-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/helper/basic-energy-source-helper.h Wed May 18 14:56:28 2011 -0700
@@ -27,7 +27,9 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Creates a BasicEnergySource object.
+ *
*/
class BasicEnergySourceHelper : public EnergySourceHelper
{
--- a/src/energy/helper/energy-model-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/helper/energy-model-helper.h Wed May 18 14:56:28 2011 -0700
@@ -35,10 +35,12 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Creates EnergySource objects.
*
* This class creates and installs an energy source onto network nodes. Only a
* single source can exist on a network node.
+ *
*/
class EnergySourceHelper
{
@@ -101,6 +103,7 @@
/**
+ * \ingroup energy
* \brief Creates DeviceEnergyModel objects.
*
* This class helps to create and install DeviceEnergyModel onto NetDevice. A
@@ -108,6 +111,7 @@
* Note that DeviceEnergyModel objects are *not* aggregated onto the node. They
* can be accessed through the EnergySource object, which *is* aggregated onto
* the node.
+ *
*/
class DeviceEnergyModelHelper
{
--- a/src/energy/helper/energy-source-container.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/helper/energy-source-container.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,7 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Holds a vector of ns3::EnergySource pointers.
*
* EnergySourceHelper returns a list of EnergySource pointers installed onto a
@@ -38,6 +39,7 @@
* energy consumption on a node easily.
*
* \see NetDeviceContainer
+ *
*/
class EnergySourceContainer : public Object
{
--- a/src/energy/helper/rv-battery-model-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/helper/rv-battery-model-helper.h Wed May 18 14:56:28 2011 -0700
@@ -27,7 +27,9 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Creates a RvBatteryModel object.
+ *
*/
class RvBatteryModelHelper : public EnergySourceHelper
{
--- a/src/energy/helper/wifi-radio-energy-model-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/helper/wifi-radio-energy-model-helper.h Wed May 18 14:56:28 2011 -0700
@@ -27,9 +27,11 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Assign WifiRadioEnergyModel to wifi devices.
*
* This installer installs WifiRadioEnergyModel for only WifiNetDevice objects.
+ *
*/
class WifiRadioEnergyModelHelper : public DeviceEnergyModelHelper
{
--- a/src/energy/model/basic-energy-source.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/basic-energy-source.h Wed May 18 14:56:28 2011 -0700
@@ -29,8 +29,10 @@
namespace ns3 {
/**
+ * \ingroup energy
* BasicEnergySource decreases/increases remaining energy stored in itself in
* linearly.
+ *
*/
class BasicEnergySource : public EnergySource
{
--- a/src/energy/model/device-energy-model-container.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/device-energy-model-container.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,7 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Holds a vector of ns3::DeviceEnergyModel pointers.
*
* DeviceEnergyModelContainer returns a list of DeviceEnergyModel pointers
@@ -37,6 +38,7 @@
* objects to obtain total device energy consumption on a node easily.
*
* \see NetDeviceContainer
+ *
*/
class DeviceEnergyModelContainer
{
--- a/src/energy/model/device-energy-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/device-energy-model.h Wed May 18 14:56:28 2011 -0700
@@ -31,12 +31,14 @@
class EnergySource;
/**
+ * \ingroup energy
* \brief Base class for device energy models.
*
* A device energy model should represent the energy consumption behavior of a
* specific device. It will update remaining energy stored in the EnergySource
* object installed on node. When energy is depleted, each DeviceEnergyModel
* object installed on the same node will be informed by the EnergySource.
+ *
*/
class DeviceEnergyModel : public Object
{
--- a/src/energy/model/energy-source.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/energy-source.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,13 @@
namespace ns3 {
/**
+ * \defgroup energy Energy Models
+ *
+ */
+
+/**
+ * \ingroup energy
+ *
* \brief Energy source base class.
*
* This is the base class for energy sources. Energy sources keep track of
--- a/src/energy/model/li-ion-energy-source.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/li-ion-energy-source.h Wed May 18 14:56:28 2011 -0700
@@ -29,6 +29,7 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Model a generic Lithium Ion Battery basing on [1][2].
*
* The model can be fitted to any type of Li-Ion Battery, simply changing the
@@ -66,6 +67,7 @@
* [1] C. M. Shepherd, "Design of Primary and Secondary Cells - Part 3. Battery discharge equation," U.S. Naval Research Laboratory, 1963
* [2] Tremblay, O.; Dessaint, L.-A.; Dekkiche, A.-I., "A Generic Battery Model for the Dynamic Simulation of Hybrid Electric Vehicles," Ecole de Technologie Superieure, Universite du Quebec, 2007
* [3] http://www.panasonic.com/industrial/includes/pdf/Panasonic_LiIon_CGR18650DA.pdf
+ *
*/
class LiIonEnergySource : public EnergySource
{
--- a/src/energy/model/rv-battery-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/rv-battery-model.h Wed May 18 14:56:28 2011 -0700
@@ -29,6 +29,7 @@
namespace ns3 {
/**
+ * \ingroup energy
* \brief Rakhmatov Vrudhula non-linear battery model.
*
* This (energy source) model implements an analytical non-linear battery model.
@@ -44,6 +45,7 @@
* "Simulation of Mobile Wireless Networks with Accurate Modeling of non-linear
* battery effects". The real-time algorithm is modified by the authors of this
* code for improved accuracy and reduced computation (sampling) overhead.
+ *
*/
class RvBatteryModel : public EnergySource
{
--- a/src/energy/model/simple-device-energy-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/simple-device-energy-model.h Wed May 18 14:56:28 2011 -0700
@@ -14,10 +14,12 @@
namespace ns3 {
/**
+ * \ingroup energy
*
* A simple device energy model where current drain can be set by the user.
*
* It is supposed to be used as a testing model for energy sources.
+ *
*/
class SimpleDeviceEnergyModel : public DeviceEnergyModel
{
--- a/src/energy/model/wifi-radio-energy-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/energy/model/wifi-radio-energy-model.h Wed May 18 14:56:28 2011 -0700
@@ -30,8 +30,10 @@
namespace ns3 {
/**
+ * \ingroup energy
* A WifiPhy listener class for notifying the WifiRadioEnergyModel of Wifi radio
* state change.
+ *
*/
class WifiRadioEnergyModelPhyListener : public WifiPhyListener
{
@@ -118,6 +120,7 @@
// -------------------------------------------------------------------------- //
/**
+ * \ingroup energy
* \brief A WiFi radio energy model.
*
* 4 states are defined for the radio: TX, RX, IDLE, SLEEP. Default state is
@@ -138,6 +141,7 @@
* Default values for power consumption are based on CC2420 radio chip, with
* supply voltage as 2.5V and currents as 17.4 mA (TX), 18.8 mA (RX), 20 uA
* (sleep) and 426 uA (idle).
+ *
*/
class WifiRadioEnergyModel : public DeviceEnergyModel
{
--- a/src/lte/helper/lte-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/helper/lte-helper.h Wed May 18 14:56:28 2011 -0700
@@ -41,12 +41,12 @@
/**
+ * \ingroup lte
* \brief helps to manage and create LteNetDevice objects
*
* This class can help to create a LteNetDevice objects
* and to configure their attributes during creation.
*/
-
class LteHelper
{
public:
--- a/src/lte/model/amc-module.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/amc-module.h Wed May 18 14:56:28 2011 -0700
@@ -28,6 +28,8 @@
/**
+ * \ingroup lte
+ *
* \brief The AMC module attached to the LTE networ device
* AmcModule class implements the Adaptive Modulation And Coding Scheme
* as proposed in 3GPP TSG-RAN WG1 - R1-081483
--- a/src/lte/model/bearer-qos-parameters.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/bearer-qos-parameters.h Wed May 18 14:56:28 2011 -0700
@@ -27,6 +27,8 @@
/**
+ * \ingroup lte
+ *
* \brief the BearerQosParameters class implements a set of Qos
* parameters associated to the bearer.
* Bearer Level Qos (TS 23.401, Clause 4.7.3)
--- a/src/lte/model/channel-realization.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/channel-realization.h Wed May 18 14:56:28 2011 -0700
@@ -34,6 +34,8 @@
/**
+ * \ingroup lte
+ *
* \brief the ChannelRealization class implements a complete propagation model
* used by the channel to compute the loss due to the propagation of the signal.
* A ChannelRealization object is created for each couple of UE - eNB.
--- a/src/lte/model/discrete-time-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/discrete-time-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
/**
+ * \ingroup lte
+ *
* \brief The DiscreteTimeLossModel class offers a basic implementation
* for all propagation loss models used for LTE networks
*/
--- a/src/lte/model/enb-lte-spectrum-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/enb-lte-spectrum-phy.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class EnbNetDevice;
/**
+ * \ingroup lte
+ *
* The EnbLteSpectrumPhy models the UL/DL physical layer for the eNodeB device
*/
class EnbLteSpectrumPhy : public LteSpectrumPhy
--- a/src/lte/model/enb-mac-entity.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/enb-mac-entity.h Wed May 18 14:56:28 2011 -0700
@@ -32,6 +32,8 @@
class PdcchMapIdealControlMessage;
/**
+ * \ingroup lte
+ *
* This class implements the MAC layer of the eNodeB device
*/
class EnbMacEntity : public MacEntity
--- a/src/lte/model/enb-net-device.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/enb-net-device.h Wed May 18 14:56:28 2011 -0700
@@ -42,6 +42,8 @@
/**
+ * \ingroup lte
+ *
* The eNodeB device implementation
*/
class EnbNetDevice : public LteNetDevice
--- a/src/lte/model/enb-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/enb-phy.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class LteNetDevice;
/**
+ * \ingroup lte
+ *
* EnbLtePhy models the physical layer for the eNodeB
*/
class EnbLtePhy : public LtePhy
--- a/src/lte/model/ideal-control-messages.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ideal-control-messages.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,8 @@
/**
+ * \ingroup lte
+ *
* The IdealControlMessage provides a basic implementations for
* control messages (such as PDCCH allocation map, CQI feedbacks)
* that are exchanged among eNodeB and UEs.
@@ -109,6 +111,8 @@
class LteNetDevice;
/**
+ * \ingroup lte
+ *
* \brief The PdcchMapIdealControlMessage defines an ideal allocation map
* for both UL and DL sends by the eNodeB to all UE,
* using an ideal PDCCH control channel.
@@ -197,6 +201,8 @@
class LteNetDevice;
/**
+ * \ingroup lte
+ *
* The CqiIdealControlMessage defines an ideal list of feedback about
* the channel quality sent by the UE to the eNodeB.
*/
--- a/src/lte/model/jakes-fading-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/jakes-fading-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,8 @@
class LtePhy;
/**
+ * \ingroup lte
+ *
* \brief JakesFadingLossModel class implements a loss model due to the fast fading.
* In particular, the fast fading is modeled using a Jakes Model
*/
--- a/src/lte/model/lte-mac-header.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-mac-header.h Wed May 18 14:56:28 2011 -0700
@@ -28,6 +28,8 @@
namespace ns3 {
/**
+ * \ingroup lte
+ *
* This class implements the LTE MAC header
*/
class LteMacHeader : public Header
--- a/src/lte/model/lte-mac-queue.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-mac-queue.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,8 @@
namespace ns3 {
/**
+ * \ingroup lte
+ *
* The MAC queue for each bearer
*/
class LteMacQueue : public Object
--- a/src/lte/model/lte-net-device.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-net-device.h Wed May 18 14:56:28 2011 -0700
@@ -39,6 +39,13 @@
class RrcEntity;
/**
+ * \defgroup lte LTE Models
+ *
+ */
+
+/**
+ * \ingroup lte
+ *
* LteNetDevice provides basic implementation for all LTE network devices
*/
class LteNetDevice : public NetDevice
--- a/src/lte/model/lte-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-phy.h Wed May 18 14:56:28 2011 -0700
@@ -40,6 +40,8 @@
class IdealControlMessage;
/**
+ * \ingroup lte
+ *
* The LtePhy models the physical layer of LTE. It is composed by two
* LteSpectrumPhy, one for the downlink and one for the uplink.
*/
--- a/src/lte/model/lte-propagation-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-propagation-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -34,6 +34,8 @@
class MobilityModel;
/**
+ * \ingroup lte
+ *
* \brief propagation loss model for LTE
*/
class LtePropagationLossModel : public SpectrumPropagationLossModel
--- a/src/lte/model/lte-spectrum-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-spectrum-phy.h Wed May 18 14:56:28 2011 -0700
@@ -42,6 +42,8 @@
class LteNetDevice;
/**
+ * \ingroup lte
+ *
* The LteSpectrumPhy models the physical layer of LTE
*/
class LteSpectrumPhy : public SpectrumPhy
--- a/src/lte/model/lte-spectrum-value-helper.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/lte-spectrum-value-helper.h Wed May 18 14:56:28 2011 -0700
@@ -29,6 +29,8 @@
/**
+ * \ingroup lte
+ *
* \brief This class defines all functions to create spectrum model for lte
*/
class LteSpectrumValueHelper
--- a/src/lte/model/mac-entity.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/mac-entity.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,8 @@
class AmcModule;
/**
+ * \ingroup lte
+ *
* This class provides a basi implementation of the MAC
* layer
*/
--- a/src/lte/model/packet-scheduler.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/packet-scheduler.h Wed May 18 14:56:28 2011 -0700
@@ -35,6 +35,8 @@
class MacEntity;
/**
+ * \ingroup lte
+ *
* This class represents the basic implementation of the LTE packet scheduler
*/
class PacketScheduler : public Object
--- a/src/lte/model/path-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/path-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class MobilityModel;
/**
+ * \ingroup lte
+ *
* \brief This class models the propagation loss model due to the path loss
*/
class PathLossModel : public DiscreteTimeLossModel
--- a/src/lte/model/penetration-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/penetration-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -28,6 +28,8 @@
namespace ns3 {
/**
+ * \ingroup lte
+ *
* \brief This class models the propagation loss model due to the penetration loss
*/
class PenetrationLossModel : public DiscreteTimeLossModel
--- a/src/lte/model/radio-bearer-instance.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/radio-bearer-instance.h Wed May 18 14:56:28 2011 -0700
@@ -31,6 +31,8 @@
class RlcEntity;
/**
+ * \ingroup lte
+ *
* This class implements the LTE radio bearer in which
* a data flow between UE and eNB will be mapped.
*/
--- a/src/lte/model/rlc-entity.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/rlc-entity.h Wed May 18 14:56:28 2011 -0700
@@ -32,6 +32,8 @@
class RadioBearerInstance;
/**
+ * \ingroup lte
+ *
* This class implements the RLC entity
*/
class RlcEntity : public Object
--- a/src/lte/model/rrc-entity.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/rrc-entity.h Wed May 18 14:56:28 2011 -0700
@@ -33,6 +33,8 @@
class Bearer;
/**
+ * \ingroup lte
+ *
* \brief This class implements the RRC entity
*/
class RrcEntity : public Object
--- a/src/lte/model/shadowing-loss-model.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/shadowing-loss-model.h Wed May 18 14:56:28 2011 -0700
@@ -29,6 +29,8 @@
/**
+ * \ingroup lte
+ *
* \brief This class models the propagation loss model due to the shadowing
*/
class ShadowingLossModel : public DiscreteTimeLossModel
--- a/src/lte/model/simple-packet-scheduler.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/simple-packet-scheduler.h Wed May 18 14:56:28 2011 -0700
@@ -33,9 +33,10 @@
/**
+ * \ingroup lte
+ *
* This class implements a simple packet scheduler
*/
-
class SimplePacketScheduler : public PacketScheduler
{
--- a/src/lte/model/ue-lte-spectrum-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-lte-spectrum-phy.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class EnbNetDevice;
/**
+ * \ingroup lte
+ *
* The UeLteSpectrumPhy models the UL/DL physical layer for the UE
*/
class UeLteSpectrumPhy : public LteSpectrumPhy
--- a/src/lte/model/ue-mac-entity.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-mac-entity.h Wed May 18 14:56:28 2011 -0700
@@ -31,9 +31,10 @@
class CqiIdealControlMessage;
/**
+ * \ingroup lte
+ *
* This class implements the MAC layer of the UE device
*/
-
class UeMacEntity : public MacEntity
{
public:
--- a/src/lte/model/ue-manager.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-manager.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class EnbNetDevice;
/**
+ * \ingroup lte
+ *
* \brief this class allow the eNodeb to manage in a very simple way all registered UE.
* In particular, to each registered UE, a new UeRecord is created.
* \see UeRecord
--- a/src/lte/model/ue-net-device.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-net-device.h Wed May 18 14:56:28 2011 -0700
@@ -41,6 +41,8 @@
class UeMacEntity;
/**
+ * \ingroup lte
+ *
* The UeNetDevice class implements the UE net device
*/
class UeNetDevice : public LteNetDevice
--- a/src/lte/model/ue-phy.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-phy.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
class LteNetDevice;
/**
+ * \ingroup lte
+ *
* The LteSpectrumPhy models the physical layer of LTE
*/
class UeLtePhy : public LtePhy
--- a/src/lte/model/ue-record.h Wed May 18 23:38:16 2011 +0200
+++ b/src/lte/model/ue-record.h Wed May 18 14:56:28 2011 -0700
@@ -30,6 +30,8 @@
namespace ns3 {
/**
+ * \ingroup lte
+ *
* \brief The UeRecord class is developerd in order to store at the eNodeB
* all information (such as feedback cqi, mac address etc...) of a UE registered
* into that eNodeB. All UE records are managed by the UeManager class