merge

src/aodv/doc/aodv.h

@@ -30,7 +30,7 @@
 #define AODV_H
 
 /**
- * \defgroup aodv AODV
+ * \defgroup aodv AODV Routing
  * 
  * This model implements the base specification of the Ad hoc on demand distance vector (AODV)
  * protocol. Implementation is based on RFC3561.

src/bridge/model/bridge-net-device.h

@@ -31,7 +31,7 @@ namespace ns3 {
 class Node;
 
 /**
- * \defgroup bridge Bridge
+ * \defgroup bridge Bridge Device
  * 
  * \brief a virtual net device that bridges multiple LAN segments
  *

src/click/doc/click.h

@@ -19,7 +19,7 @@
  */
 
 /**
-* \defgroup click Click
+* \defgroup click Click Routing
 *
 * \section model Model
 *

src/config-store/model/attribute-iterator.h

@@ -27,7 +27,11 @@ namespace ns3 {
 
 class ObjectVectorValue;
 
-// This class is used internally by ConfigStore and GtkConfigStore.
+/**
+ * \ingroup configstore
+ *
+ * This class is used internally by ConfigStore and GtkConfigStore.
+ */
 class AttributeIterator
 {
 public:

src/config-store/model/config-store.h

@@ -7,6 +7,8 @@
 namespace ns3 {
 
 /**
+ * \defgroup configstore Config-Store
+ *
  * \brief Store and load simulation attribute configuration
  *
  * While it is possible to generate a sample config file and lightly
@@ -24,6 +26,11 @@ namespace ns3 {
  * configuration files where all the instances of the same parameter
  * are changed.
  */
+
+/**
+ * \ingroup configstore
+ *
+ */
 class ConfigStore : public ObjectBase
 {
 public:

src/config-store/model/file-config.h

@@ -5,6 +5,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup configstore
+ *
+ */
 class FileConfig
 {
 public:
@@ -15,6 +19,10 @@ public:
   virtual void Attributes (void) = 0;
 };
 
+/**
+ * \ingroup configstore
+ *
+ */
 class NoneFileConfig : public FileConfig
 {
 public:

src/config-store/model/gtk-config-store.h

@@ -23,7 +23,9 @@
 namespace ns3 {
 
 /**
+ * \ingroup configstore
  * \brief A class that provides a GTK-based front end to ns3::ConfigStore 
+ *
  */
 class GtkConfigStore
 {

src/config-store/model/model-node-creator.h

@@ -47,6 +47,10 @@ struct ModelNode
   Ptr<Object> object;
   uint32_t index;
 };
+/**
+ * \ingroup configstore
+ *
+ */
 class ModelCreator : public AttributeIterator
 {
 public:

src/config-store/model/raw-text-config.h

@@ -7,6 +7,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup configstore
+ *
+ */
 class RawTextConfigSave : public FileConfig
 {
 public:
@@ -20,6 +24,10 @@ private:
   std::ofstream *m_os;
 };
 
+/**
+ * \ingroup configstore
+ *
+ */
 class RawTextConfigLoad : public FileConfig
 {
 public:

src/config-store/model/xml-config.h

@@ -8,6 +8,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup configstore
+ *
+ */
 class XmlConfigSave : public FileConfig
 {
 public:
@@ -22,6 +26,10 @@ private:
   xmlTextWriterPtr m_writer;
 };
 
+/**
+ * \ingroup configstore
+ *
+ */
 class XmlConfigLoad : public FileConfig
 {
 public:

src/csma-layout/model/csma-star-helper.h

@@ -29,6 +29,13 @@
 namespace ns3 {
 
 /**
+ * \defgroup csmastarhelper CSMA Star Helper
+ *
+ */
+
+/**
+ * \ingroup csmastarhelper
+ *
  * \brief A helper to make it easier to create a star topology
  * with Csma links
  */

src/csma/doc/csma.h

@@ -1,5 +1,5 @@
 /**
- * \defgroup CsmaModel CSMA Model
+ * \defgroup CsmaModel CSMA Device
  *
  * \section CsmaModelOverview CSMA Model Overview
  *

src/dsdv/doc/dsdv.h

@@ -33,7 +33,7 @@
 #define DSDV_H_
 
 /**
- * \defgroup dsdv DSDV
+ * \defgroup dsdv DSDV Routing
  * 
  * \brief Destination-Sequenced Distance Vector (DSDV) routing protocol is a pro-active, table-driven routing protocol
  *  for MANETs developed by Charles E. Perkins and Pravin Bhagwat in 1994. It uses the hop count as metric in route

src/emu/doc/emu.h

@@ -1,5 +1,5 @@
 /**
- * \defgroup EmuModel Emulated Net Device Model
+ * \defgroup EmuModel Emulated Device
  *
  * \section EmuModelOverview Emulated Net Device Model Overview
  *

src/mesh/doc/mesh.h

@@ -23,7 +23,7 @@
  */
 
 /**
- * \defgroup mesh Mesh
+ * \defgroup mesh Mesh Device
  *
  * \brief MAC-layer mobile mesh networking.
  * \section MeshOverview Overview of Layer-2 Mesh networking protocols

src/nix-vector-routing/doc/nix-vector-routing.h

@@ -19,7 +19,7 @@
  */
 
 /**
- * \defgroup nixvectorrouting Nix-vector Routing
+ * \defgroup nixvectorrouting Nix-Vector Routing
  *
  * \section model Model
  *

src/olsr/doc/olsr.h

@@ -22,7 +22,7 @@
 #define OLSR_H
 
 /**
- * \defgroup olsr OLSR
+ * \defgroup olsr OLSR Routing
  *
  * \section model Model
  *

src/openflow/doc/openflow-switch.h

@@ -21,7 +21,7 @@
  */
 
 /**
- * \defgroup OpenFlowSwitchModel OpenFlow Switch Model
+ * \defgroup OpenFlowSwitchModel OpenFlow Switch Device
  *
  * \section OpenFlowSwitchModelOverview OpenFlow Switch Model Overview
  *

src/point-to-point/doc/point-to-point.h

@@ -1,5 +1,5 @@
 /**
- * \defgroup PointToPointModel Point-to-Point Model
+ * \defgroup PointToPointModel Point-to-Point Device
  *
  * \section PointToPointPointOverview Point-to-Point Model Overview
  *

src/tap-bridge/doc/tap.h

@@ -1,5 +1,5 @@
 /**
- * \defgroup TapBridgeModel Tap Bridge Model
+ * \defgroup TapBridgeModel Tap Bridge Device
  *
  * \section TapBridgeModelOverview TapBridge Model Overview
  *

src/wifi/model/wifi-net-device.h

@@ -35,7 +35,7 @@ class WifiPhy;
 class WifiMac;
 
 /**
- * \defgroup wifi Wifi
+ * \defgroup wifi Wifi Models
  *
  * This section documents the API of the ns-3 Wifi module. For a generic functional description, please refer to the ns-3 manual.
  */