From 1c345c4d7633b73f7e0c27bee5512d9c1eb715a5 Mon Sep 17 00:00:00 2001 From: Mitch Watrous Date: Tue, 17 May 2011 17:36:08 -0700 Subject: [PATCH] Updated the modules doxygen page --- doc/main.h | 48 +++++++++++++++---- doc/modules | 21 ++++---- src/aodv/doc/aodv.h | 1 - src/bridge/model/bridge-net-device.h | 1 - src/click/doc/click.h | 1 - src/core/model/assert.h | 2 +- src/csma/doc/csma.h | 1 - src/dsdv/doc/dsdv.h | 3 +- src/dsdv/model/dsdv-packet.h | 1 + src/emu/doc/emu.h | 1 - src/internet/model/global-routing.h | 2 +- src/internet/model/ipv4-list-routing.h | 2 +- src/internet/model/ipv4-routing-table-entry.h | 4 +- src/internet/model/ipv4-static-routing.h | 2 +- src/internet/model/ipv6-list-routing.h | 2 +- src/internet/model/ipv6-static-routing.h | 2 +- src/mesh/doc/mesh.h | 1 - .../doc/nix-vector-routing.h | 1 - src/olsr/doc/olsr.h | 1 - src/openflow/doc/openflow-switch.h | 1 - .../model/openflow-switch-net-device.h | 1 - src/point-to-point/doc/point-to-point.h | 1 - src/tap-bridge/doc/tap.h | 1 - src/uan/doc/uan.h | 1 - src/wimax/doc/wimax.h | 1 - utils/print-introspected-doxygen.cc | 6 +-- 26 files changed, 63 insertions(+), 46 deletions(-) diff --git a/doc/main.h b/doc/main.h index da9bdf17e..eeb6e4331 100644 --- a/doc/main.h +++ b/doc/main.h @@ -34,14 +34,46 @@ * * \section module-sec Module overview * - * The ns-3 library is split across many modules. : - * - core: located in src/core and contains a number of facilities which - * do not depend on any other module. Some of these facilities are - * OS-dependent. - * - network: located in src/network. Network related files. - * - internet: located in src/internet. Internet related files. - * - applications: located in src/applications - * - mobility: located in src/mobility; Mobility models for nodes + * The ns-3 library is split across many modules: + * - aodv + * - applications + * - bridge + * - click + * - config-store + * - core + * - csma + * - csma-layout + * - dsdv + * - emu + * - energy + * - flow-monitor + * - internet + * - lte + * - mesh + * - mobility + * - mpi + * - netanim + * - network + * - nix-vector-routing + * - ns3tcp + * - ns3wifi + * - olsr + * - openflow + * - point-to-point + * - point-to-point-layout + * - propagation + * - spectrum + * - stats + * - tap-bridge + * - template + * - test + * - tools + * - topology-read + * - uan + * - virtual-net-device + * - visualizer + * - wifi + * - wimax * * More detail can be found in the Modules * tab. diff --git a/doc/modules b/doc/modules index 0b25a57f5..f58e8f671 100644 --- a/doc/modules +++ b/doc/modules @@ -1,6 +1,16 @@ /** * @anchor modules_anchor * + * @defgroup constructs C++ Constructs Used by All Modules + * \brief These are C++ constructs defined by the modules. + * + * @defgroup constants Constants + * @brief Constants you can change + * + * @defgroup utils Utils + * @brief The utils directory is for various programs and scripts related + * to code coverage, test suites, style checking, and benchmarking. + * * @defgroup core Core * \brief The "core" module contains: * - a time management class to hold a time and convert between various time units: ns3::Time @@ -33,8 +43,6 @@ * - models which abstract the application-layer API: ns3::Application, * ns3::Socket, ns3::SocketFactory, and, ns3::Udp * - * @defgroup devices Devices - * * @defgroup internet Internet * * The "internet" module contains: @@ -43,16 +51,7 @@ * - an ARP module * - a UDP and a TCP implementation * - * @defgroup routing Routing - * * @defgroup applications Applications * * @defgroup mobility Mobility - * - * @defgroup constants Constants - * @brief Constants you can change - * - * @defgroup utils Utils - * @brief The utils directory is for various programs and scripts related - * to code coverage, test suites, style checking, and benchmarking. */ diff --git a/src/aodv/doc/aodv.h b/src/aodv/doc/aodv.h index 58095d4c8..6ac5eae3c 100644 --- a/src/aodv/doc/aodv.h +++ b/src/aodv/doc/aodv.h @@ -30,7 +30,6 @@ #define AODV_H /** - * \ingroup routing * \defgroup aodv AODV * * This model implements the base specification of the Ad hoc on demand distance vector (AODV) diff --git a/src/bridge/model/bridge-net-device.h b/src/bridge/model/bridge-net-device.h index 0db239f5e..b73c550eb 100644 --- a/src/bridge/model/bridge-net-device.h +++ b/src/bridge/model/bridge-net-device.h @@ -31,7 +31,6 @@ namespace ns3 { class Node; /** - * \ingroup devices * \defgroup bridge Bridge * * \brief a virtual net device that bridges multiple LAN segments diff --git a/src/click/doc/click.h b/src/click/doc/click.h index c21230de3..de2924e2c 100644 --- a/src/click/doc/click.h +++ b/src/click/doc/click.h @@ -19,7 +19,6 @@ */ /** -* \ingroup routing * \defgroup click Click * * \section model Model diff --git a/src/core/model/assert.h b/src/core/model/assert.h index 55316a8f8..12f7ec0f5 100644 --- a/src/core/model/assert.h +++ b/src/core/model/assert.h @@ -28,7 +28,7 @@ #include "fatal-error.h" /** - * \ingroup core + * \ingroup constructs * \defgroup debugging Debugging */ /** diff --git a/src/csma/doc/csma.h b/src/csma/doc/csma.h index f56fba0b7..93118ab26 100644 --- a/src/csma/doc/csma.h +++ b/src/csma/doc/csma.h @@ -1,5 +1,4 @@ /** - * \ingroup devices * \defgroup CsmaModel CSMA Model * * \section CsmaModelOverview CSMA Model Overview diff --git a/src/dsdv/doc/dsdv.h b/src/dsdv/doc/dsdv.h index eb236400e..1fb636342 100644 --- a/src/dsdv/doc/dsdv.h +++ b/src/dsdv/doc/dsdv.h @@ -33,8 +33,7 @@ #define DSDV_H_ /** - * \ingroup routing - * \defgroup dsdv + * \defgroup dsdv DSDV * * \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 diff --git a/src/dsdv/model/dsdv-packet.h b/src/dsdv/model/dsdv-packet.h index e0255935d..bb3e2e7e8 100644 --- a/src/dsdv/model/dsdv-packet.h +++ b/src/dsdv/model/dsdv-packet.h @@ -51,6 +51,7 @@ namespace dsdv { +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Sequence Number | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + * \endverbatim */ class DsdvHeader : public Header diff --git a/src/emu/doc/emu.h b/src/emu/doc/emu.h index 35e0f8235..87cf51584 100644 --- a/src/emu/doc/emu.h +++ b/src/emu/doc/emu.h @@ -1,5 +1,4 @@ /** - * \ingroup devices * \defgroup EmuModel Emulated Net Device Model * * \section EmuModelOverview Emulated Net Device Model Overview diff --git a/src/internet/model/global-routing.h b/src/internet/model/global-routing.h index c1c6c2c51..8ea92155f 100644 --- a/src/internet/model/global-routing.h +++ b/src/internet/model/global-routing.h @@ -18,7 +18,7 @@ */ /** - * \ingroup routing + * \ingroup internet * \defgroup globalrouting Global Routing * * \section model Model diff --git a/src/internet/model/ipv4-list-routing.h b/src/internet/model/ipv4-list-routing.h index 2769c22f7..0387b9724 100644 --- a/src/internet/model/ipv4-list-routing.h +++ b/src/internet/model/ipv4-list-routing.h @@ -26,7 +26,7 @@ namespace ns3 { /** - * \ingroup routing + * \ingroup internet * \defgroup ipv4ListRouting Ipv4 List Routing */ /** diff --git a/src/internet/model/ipv4-routing-table-entry.h b/src/internet/model/ipv4-routing-table-entry.h index 540916d65..9c280ef12 100644 --- a/src/internet/model/ipv4-routing-table-entry.h +++ b/src/internet/model/ipv4-routing-table-entry.h @@ -29,7 +29,7 @@ namespace ns3 { /** - * \ingroup routing + * \ingroup internet * * A record of an IPv4 routing table entry for Ipv4GlobalRouting and * Ipv4StaticRouting. This is not a reference counted object. @@ -157,7 +157,7 @@ private: std::ostream& operator<< (std::ostream& os, Ipv4RoutingTableEntry const& route); /** - * \ingroup routing + * \ingroup internet * * \brief A record of an IPv4 multicast route for Ipv4GlobalRouting and Ipv4StaticRouting */ diff --git a/src/internet/model/ipv4-static-routing.h b/src/internet/model/ipv4-static-routing.h index 2fa940d24..e74b2ed09 100644 --- a/src/internet/model/ipv4-static-routing.h +++ b/src/internet/model/ipv4-static-routing.h @@ -44,7 +44,7 @@ class Ipv4MulticastRoutingTableEntry; class Node; /** - * \ingroup routing + * \ingroup internet * \defgroup ipv4StaticRouting Ipv4StaticRouting */ /** diff --git a/src/internet/model/ipv6-list-routing.h b/src/internet/model/ipv6-list-routing.h index 0c1d8c16f..bdeff3777 100644 --- a/src/internet/model/ipv6-list-routing.h +++ b/src/internet/model/ipv6-list-routing.h @@ -25,7 +25,7 @@ namespace ns3 { /** - * \ingroup routing + * \ingroup internet * \defgroup ipv6ListRouting Ipv6 List Routing */ diff --git a/src/internet/model/ipv6-static-routing.h b/src/internet/model/ipv6-static-routing.h index e9c06c464..f6355d8fe 100644 --- a/src/internet/model/ipv6-static-routing.h +++ b/src/internet/model/ipv6-static-routing.h @@ -43,7 +43,7 @@ class Ipv6RoutingTableEntry; class Ipv6MulticastRoutingTableEntry; /** - * \ingroup routing + * \ingroup internet * \defgroup ipv6StaticRouting Ipv6StaticRouting */ /** diff --git a/src/mesh/doc/mesh.h b/src/mesh/doc/mesh.h index 148e4926b..0c2bf0d6c 100644 --- a/src/mesh/doc/mesh.h +++ b/src/mesh/doc/mesh.h @@ -23,7 +23,6 @@ */ /** - * \ingroup devices * \defgroup mesh Mesh * * \brief MAC-layer mobile mesh networking. diff --git a/src/nix-vector-routing/doc/nix-vector-routing.h b/src/nix-vector-routing/doc/nix-vector-routing.h index d2a67df59..ebb0fccd7 100644 --- a/src/nix-vector-routing/doc/nix-vector-routing.h +++ b/src/nix-vector-routing/doc/nix-vector-routing.h @@ -19,7 +19,6 @@ */ /** - * \ingroup routing * \defgroup nixvectorrouting Nix-vector Routing * * \section model Model diff --git a/src/olsr/doc/olsr.h b/src/olsr/doc/olsr.h index 0b37c5c22..c4e8570da 100644 --- a/src/olsr/doc/olsr.h +++ b/src/olsr/doc/olsr.h @@ -22,7 +22,6 @@ #define OLSR_H /** - * \ingroup routing * \defgroup olsr OLSR * * \section model Model diff --git a/src/openflow/doc/openflow-switch.h b/src/openflow/doc/openflow-switch.h index 436e66094..f37729834 100644 --- a/src/openflow/doc/openflow-switch.h +++ b/src/openflow/doc/openflow-switch.h @@ -21,7 +21,6 @@ */ /** - * \ingroup devices * \defgroup OpenFlowSwitchModel OpenFlow Switch Model * * \section OpenFlowSwitchModelOverview OpenFlow Switch Model Overview diff --git a/src/openflow/model/openflow-switch-net-device.h b/src/openflow/model/openflow-switch-net-device.h index 56ee6a22e..63c2492bd 100644 --- a/src/openflow/model/openflow-switch-net-device.h +++ b/src/openflow/model/openflow-switch-net-device.h @@ -47,7 +47,6 @@ namespace ns3 { /** - * \ingroup devices * \defgroup openflow OpenFlow * * \brief A net device that switches multiple LAN segments via an OpenFlow-compatible flow table diff --git a/src/point-to-point/doc/point-to-point.h b/src/point-to-point/doc/point-to-point.h index 08dbd3ce1..fc19d046d 100644 --- a/src/point-to-point/doc/point-to-point.h +++ b/src/point-to-point/doc/point-to-point.h @@ -1,5 +1,4 @@ /** - * \ingroup devices * \defgroup PointToPointModel Point-to-Point Model * * \section PointToPointPointOverview Point-to-Point Model Overview diff --git a/src/tap-bridge/doc/tap.h b/src/tap-bridge/doc/tap.h index cb180eee4..84665e451 100644 --- a/src/tap-bridge/doc/tap.h +++ b/src/tap-bridge/doc/tap.h @@ -1,5 +1,4 @@ /** - * \ingroup devices * \defgroup TapBridgeModel Tap Bridge Model * * \section TapBridgeModelOverview TapBridge Model Overview diff --git a/src/uan/doc/uan.h b/src/uan/doc/uan.h index e1918d0fa..f07362a5d 100644 --- a/src/uan/doc/uan.h +++ b/src/uan/doc/uan.h @@ -19,7 +19,6 @@ */ /** - * \ingroup devices * \defgroup UAN UAN Models * * \section UanOverview UAN Framework Overview diff --git a/src/wimax/doc/wimax.h b/src/wimax/doc/wimax.h index 62c4980ee..ce2ac6199 100644 --- a/src/wimax/doc/wimax.h +++ b/src/wimax/doc/wimax.h @@ -1,5 +1,4 @@ /** - * \ingroup devices * \defgroup WiMAX WiMAX Models * * \section WiMAXModelOverview WiMAX Model Overview diff --git a/utils/print-introspected-doxygen.cc b/utils/print-introspected-doxygen.cc index d0db37c6e..be89b7574 100644 --- a/utils/print-introspected-doxygen.cc +++ b/utils/print-introspected-doxygen.cc @@ -351,7 +351,7 @@ int main (int argc, char *argv[]) std::cout << "/*!" << std::endl - << "\\ingroup core" << std::endl + << "\\ingroup constructs" << std::endl << "\\defgroup TraceSourceList The list of all trace sources." << std::endl; for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i) { @@ -373,7 +373,7 @@ int main (int argc, char *argv[]) std::cout << "/*!" << std::endl - << "\\ingroup core" << std::endl + << "\\ingroup constructs" << std::endl << "\\defgroup AttributeList The list of all attributes." << std::endl; for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i) { @@ -396,7 +396,7 @@ int main (int argc, char *argv[]) std::cout << "/*!" << std::endl - << "\\ingroup core" << std::endl + << "\\ingroup constructs" << std::endl << "\\defgroup GlobalValueList The list of all global values." << std::endl << "