View | Details | Raw Unified | Return to bug 1128
Collapse All | Expand All

(-)a/doc/main.h (-8 / +40 lines)
 Lines 34-47    Link Here 
34
 * 
34
 * 
35
 * \section module-sec Module overview
35
 * \section module-sec Module overview
36
 *
36
 *
37
 * The ns-3 library is split across many modules.  :
37
 * The ns-3 library is split across many modules:
38
 *     - core: located in src/core and contains a number of facilities which
38
 *     - aodv
39
 *       do not depend on any other module. Some of these facilities are
39
 *     - applications
40
 *       OS-dependent.
40
 *     - bridge
41
 *     - network: located in src/network. Network related files.
41
 *     - click
42
 *     - internet: located in src/internet. Internet related files.
42
 *     - config-store
43
 *     - applications: located in src/applications
43
 *     - core
44
 *     - mobility:  located in src/mobility; Mobility models for nodes
44
 *     - csma
45
 *     - csma-layout
46
 *     - dsdv
47
 *     - emu
48
 *     - energy
49
 *     - flow-monitor
50
 *     - internet
51
 *     - lte
52
 *     - mesh
53
 *     - mobility
54
 *     - mpi
55
 *     - netanim
56
 *     - network
57
 *     - nix-vector-routing
58
 *     - ns3tcp
59
 *     - ns3wifi
60
 *     - olsr
61
 *     - openflow
62
 *     - point-to-point
63
 *     - point-to-point-layout
64
 *     - propagation
65
 *     - spectrum
66
 *     - stats
67
 *     - tap-bridge
68
 *     - template
69
 *     - test
70
 *     - tools
71
 *     - topology-read
72
 *     - uan
73
 *     - virtual-net-device
74
 *     - visualizer
75
 *     - wifi
76
 *     - wimax
45
 *
77
 *
46
 * More detail can be found in the <b><a href="modules.html">Modules</a></b>
78
 * More detail can be found in the <b><a href="modules.html">Modules</a></b>
47
 * tab.
79
 * tab.
(-)a/doc/modules (-11 / +10 lines)
 Lines 1-6    Link Here 
1
/**
1
/**
2
 * @anchor modules_anchor
2
 * @anchor modules_anchor
3
 *
3
 *
4
 * @defgroup constructs C++ Constructs Used by All Modules
5
 * \brief These are C++ constructs defined by the modules.
6
 *
7
 * @defgroup constants Constants
8
 * @brief Constants you can change
9
 *
10
 * @defgroup utils Utils
11
 * @brief The utils directory is for various programs and scripts related 
12
 * to code coverage, test suites, style checking, and benchmarking.
13
 *
4
 * @defgroup core Core
14
 * @defgroup core Core
5
 * \brief The "core" module contains:
15
 * \brief The "core" module contains:
6
 *    - a time management class to hold a time and convert between various time units: ns3::Time 
16
 *    - a time management class to hold a time and convert between various time units: ns3::Time 
 Lines 33-40    Link Here 
33
 *    - models which abstract the application-layer API: ns3::Application,
43
 *    - models which abstract the application-layer API: ns3::Application,
34
 *      ns3::Socket, ns3::SocketFactory, and, ns3::Udp
44
 *      ns3::Socket, ns3::SocketFactory, and, ns3::Udp
35
 * 
45
 * 
36
 * @defgroup devices Devices
37
 *
38
 * @defgroup internet Internet
46
 * @defgroup internet Internet
39
 * 
47
 * 
40
 * The "internet" module contains:
48
 * The "internet" module contains:
 Lines 43-58    Link Here 
43
 *    - an ARP module
51
 *    - an ARP module
44
 *    - a UDP and a TCP implementation
52
 *    - a UDP and a TCP implementation
45
 *    
53
 *    
46
 * @defgroup routing Routing
47
 *
48
 * @defgroup applications Applications
54
 * @defgroup applications Applications
49
 *
55
 *
50
 * @defgroup mobility Mobility
56
 * @defgroup mobility Mobility
51
 *
52
 * @defgroup constants Constants
53
 * @brief Constants you can change
54
 *
55
 * @defgroup utils Utils
56
 * @brief The utils directory is for various programs and scripts related 
57
 * to code coverage, test suites, style checking, and benchmarking.
58
 */
57
 */
(-)a/src/aodv/doc/aodv.h (-1 lines)
 Lines 30-36    Link Here 
30
#define AODV_H
30
#define AODV_H
31
31
32
/**
32
/**
33
 * \ingroup routing
34
 * \defgroup aodv AODV
33
 * \defgroup aodv AODV
35
 * 
34
 * 
36
 * This model implements the base specification of the Ad hoc on demand distance vector (AODV)
35
 * This model implements the base specification of the Ad hoc on demand distance vector (AODV)
(-)a/src/bridge/model/bridge-net-device.h (-1 lines)
 Lines 31-37    Link Here 
31
class Node;
31
class Node;
32
32
33
/**
33
/**
34
 * \ingroup devices
35
 * \defgroup bridge Bridge
34
 * \defgroup bridge Bridge
36
 * 
35
 * 
37
 * \brief a virtual net device that bridges multiple LAN segments
36
 * \brief a virtual net device that bridges multiple LAN segments
(-)a/src/click/doc/click.h (-1 lines)
 Lines 19-25    Link Here 
19
 */
19
 */
20
20
21
/**
21
/**
22
* \ingroup routing
23
* \defgroup click Click
22
* \defgroup click Click
24
*
23
*
25
* \section model Model
24
* \section model Model
(-)a/src/core/model/assert.h (-1 / +1 lines)
 Lines 28-34    Link Here 
28
#include "fatal-error.h"
28
#include "fatal-error.h"
29
29
30
/**
30
/**
31
 * \ingroup core
31
 * \ingroup constructs
32
 * \defgroup debugging Debugging
32
 * \defgroup debugging Debugging
33
 */
33
 */
34
/**
34
/**
(-)a/src/csma/doc/csma.h (-1 lines)
 Lines 1-5    Link Here 
1
/**
1
/**
2
 * \ingroup devices
3
 * \defgroup CsmaModel CSMA Model
2
 * \defgroup CsmaModel CSMA Model
4
 *
3
 *
5
 * \section CsmaModelOverview CSMA Model Overview
4
 * \section CsmaModelOverview CSMA Model Overview
(-)a/src/dsdv/doc/dsdv.h (-2 / +1 lines)
 Lines 33-40    Link Here 
33
#define DSDV_H_
33
#define DSDV_H_
34
34
35
/**
35
/**
36
 * \ingroup routing
36
 * \defgroup dsdv DSDV
37
 * \defgroup dsdv
38
 * 
37
 * 
39
 * \brief Destination-Sequenced Distance Vector (DSDV) routing protocol is a pro-active, table-driven routing protocol
38
 * \brief Destination-Sequenced Distance Vector (DSDV) routing protocol is a pro-active, table-driven routing protocol
40
 *  for MANETs developed by Charles E. Perkins and Pravin Bhagwat in 1994. It uses the hop count as metric in route
39
 *  for MANETs developed by Charles E. Perkins and Pravin Bhagwat in 1994. It uses the hop count as metric in route
(-)a/src/dsdv/model/dsdv-packet.h (+1 lines)
 Lines 51-56    Link Here 
51
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
52
 |                       Sequence Number                         |
52
 |                       Sequence Number                         |
53
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
53
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
54
 * \endverbatim
54
 */
55
 */
55
56
56
class DsdvHeader : public Header
57
class DsdvHeader : public Header
(-)a/src/emu/doc/emu.h (-1 lines)
 Lines 1-5    Link Here 
1
/**
1
/**
2
 * \ingroup devices
3
 * \defgroup EmuModel Emulated Net Device Model
2
 * \defgroup EmuModel Emulated Net Device Model
4
 *
3
 *
5
 * \section EmuModelOverview Emulated Net Device Model Overview
4
 * \section EmuModelOverview Emulated Net Device Model Overview
(-)a/src/internet/model/global-routing.h (-1 / +1 lines)
 Lines 18-24    Link Here 
18
 */
18
 */
19
19
20
/**
20
/**
21
 * \ingroup routing
21
 * \ingroup internet
22
 * \defgroup globalrouting Global Routing
22
 * \defgroup globalrouting Global Routing
23
 *
23
 *
24
 * \section model Model
24
 * \section model Model
(-)a/src/internet/model/ipv4-list-routing.h (-1 / +1 lines)
 Lines 26-32    Link Here 
26
namespace ns3 {
26
namespace ns3 {
27
27
28
/**
28
/**
29
 * \ingroup routing 
29
 * \ingroup internet 
30
 * \defgroup ipv4ListRouting Ipv4 List Routing
30
 * \defgroup ipv4ListRouting Ipv4 List Routing
31
 */
31
 */
32
/**
32
/**
(-)a/src/internet/model/ipv4-routing-table-entry.h (-2 / +2 lines)
 Lines 29-35    Link Here 
29
namespace ns3 {
29
namespace ns3 {
30
30
31
/**
31
/**
32
 * \ingroup routing
32
 * \ingroup internet
33
 *
33
 *
34
 * A record of an IPv4 routing table entry for Ipv4GlobalRouting and 
34
 * A record of an IPv4 routing table entry for Ipv4GlobalRouting and 
35
 * Ipv4StaticRouting.  This is not a reference counted object.
35
 * Ipv4StaticRouting.  This is not a reference counted object.
 Lines 157-163    Link Here 
157
std::ostream& operator<< (std::ostream& os, Ipv4RoutingTableEntry const& route);
157
std::ostream& operator<< (std::ostream& os, Ipv4RoutingTableEntry const& route);
158
158
159
/**
159
/**
160
 * \ingroup routing
160
 * \ingroup internet
161
 *
161
 *
162
 * \brief A record of an IPv4 multicast route for Ipv4GlobalRouting and Ipv4StaticRouting
162
 * \brief A record of an IPv4 multicast route for Ipv4GlobalRouting and Ipv4StaticRouting
163
 */
163
 */
(-)a/src/internet/model/ipv4-static-routing.h (-1 / +1 lines)
 Lines 44-50    Link Here 
44
class Node;
44
class Node;
45
45
46
/**
46
/**
47
 * \ingroup routing
47
 * \ingroup internet
48
 * \defgroup ipv4StaticRouting Ipv4StaticRouting
48
 * \defgroup ipv4StaticRouting Ipv4StaticRouting
49
 */
49
 */
50
/**
50
/**
(-)a/src/internet/model/ipv6-list-routing.h (-1 / +1 lines)
 Lines 25-31    Link Here 
25
namespace ns3 {
25
namespace ns3 {
26
26
27
/**
27
/**
28
 * \ingroup routing 
28
 * \ingroup internet 
29
 * \defgroup ipv6ListRouting Ipv6 List Routing
29
 * \defgroup ipv6ListRouting Ipv6 List Routing
30
 */
30
 */
31
31
(-)a/src/internet/model/ipv6-static-routing.h (-1 / +1 lines)
 Lines 43-49    Link Here 
43
class Ipv6MulticastRoutingTableEntry;
43
class Ipv6MulticastRoutingTableEntry;
44
44
45
/**
45
/**
46
 * \ingroup routing
46
 * \ingroup internet
47
 * \defgroup ipv6StaticRouting Ipv6StaticRouting
47
 * \defgroup ipv6StaticRouting Ipv6StaticRouting
48
 */
48
 */
49
/**
49
/**
(-)a/src/mesh/doc/mesh.h (-1 lines)
 Lines 23-29    Link Here 
23
 */
23
 */
24
24
25
/**
25
/**
26
 * \ingroup devices
27
 * \defgroup mesh Mesh
26
 * \defgroup mesh Mesh
28
 *
27
 *
29
 * \brief MAC-layer mobile mesh networking.
28
 * \brief MAC-layer mobile mesh networking.
(-)a/src/nix-vector-routing/doc/nix-vector-routing.h (-1 lines)
 Lines 19-25    Link Here 
19
 */
19
 */
20
20
21
/**
21
/**
22
 * \ingroup routing
23
 * \defgroup nixvectorrouting Nix-vector Routing
22
 * \defgroup nixvectorrouting Nix-vector Routing
24
 *
23
 *
25
 * \section model Model
24
 * \section model Model
(-)a/src/olsr/doc/olsr.h (-1 lines)
 Lines 22-28    Link Here 
22
#define OLSR_H
22
#define OLSR_H
23
23
24
/**
24
/**
25
 * \ingroup routing
26
 * \defgroup olsr OLSR
25
 * \defgroup olsr OLSR
27
 *
26
 *
28
 * \section model Model
27
 * \section model Model
(-)a/src/openflow/doc/openflow-switch.h (-1 lines)
 Lines 21-27    Link Here 
21
 */
21
 */
22
22
23
/**
23
/**
24
 * \ingroup devices
25
 * \defgroup OpenFlowSwitchModel OpenFlow Switch Model
24
 * \defgroup OpenFlowSwitchModel OpenFlow Switch Model
26
 *
25
 *
27
 * \section OpenFlowSwitchModelOverview OpenFlow Switch Model Overview
26
 * \section OpenFlowSwitchModelOverview OpenFlow Switch Model Overview
(-)a/src/openflow/model/openflow-switch-net-device.h (-1 lines)
 Lines 47-53    Link Here 
47
namespace ns3 {
47
namespace ns3 {
48
48
49
/**
49
/**
50
 * \ingroup devices
51
 * \defgroup openflow OpenFlow
50
 * \defgroup openflow OpenFlow
52
 *
51
 *
53
 * \brief A net device that switches multiple LAN segments via an OpenFlow-compatible flow table
52
 * \brief A net device that switches multiple LAN segments via an OpenFlow-compatible flow table
(-)a/src/point-to-point/doc/point-to-point.h (-1 lines)
 Lines 1-5    Link Here 
1
/**
1
/**
2
 * \ingroup devices
3
 * \defgroup PointToPointModel Point-to-Point Model
2
 * \defgroup PointToPointModel Point-to-Point Model
4
 *
3
 *
5
 * \section PointToPointPointOverview Point-to-Point Model Overview
4
 * \section PointToPointPointOverview Point-to-Point Model Overview
(-)a/src/tap-bridge/doc/tap.h (-1 lines)
 Lines 1-5    Link Here 
1
/**
1
/**
2
 * \ingroup devices
3
 * \defgroup TapBridgeModel Tap Bridge Model
2
 * \defgroup TapBridgeModel Tap Bridge Model
4
 *
3
 *
5
 * \section TapBridgeModelOverview TapBridge Model Overview
4
 * \section TapBridgeModelOverview TapBridge Model Overview
(-)a/src/uan/doc/uan.h (-1 lines)
 Lines 19-25    Link Here 
19
 */
19
 */
20
20
21
/**
21
/**
22
 * \ingroup devices
23
 * \defgroup UAN UAN Models
22
 * \defgroup UAN UAN Models
24
 *
23
 *
25
 * \section UanOverview UAN Framework Overview
24
 * \section UanOverview UAN Framework Overview
(-)a/src/wimax/doc/wimax.h (-1 lines)
 Lines 1-5    Link Here 
1
/**
1
/**
2
 * \ingroup devices
3
 * \defgroup WiMAX WiMAX Models
2
 * \defgroup WiMAX WiMAX Models
4
 *
3
 *
5
 * \section WiMAXModelOverview WiMAX Model Overview
4
 * \section WiMAXModelOverview WiMAX Model Overview
(-)a/utils/print-introspected-doxygen.cc (-3 / +3 lines)
 Lines 351-357    Link Here 
351
351
352
352
353
  std::cout << "/*!" << std::endl
353
  std::cout << "/*!" << std::endl
354
	    << "\\ingroup core" << std::endl
354
	    << "\\ingroup constructs" << std::endl
355
	    << "\\defgroup TraceSourceList The list of all trace sources." << std::endl;
355
	    << "\\defgroup TraceSourceList The list of all trace sources." << std::endl;
356
  for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i)
356
  for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i)
357
    {
357
    {
 Lines 373-379    Link Here 
373
373
374
374
375
  std::cout << "/*!" << std::endl
375
  std::cout << "/*!" << std::endl
376
	    << "\\ingroup core" << std::endl
376
	    << "\\ingroup constructs" << std::endl
377
	    << "\\defgroup AttributeList The list of all attributes." << std::endl;
377
	    << "\\defgroup AttributeList The list of all attributes." << std::endl;
378
  for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i)
378
  for (uint32_t i = 0; i < TypeId::GetRegisteredN (); ++i)
379
    {
379
    {
 Lines 396-402    Link Here 
396
396
397
397
398
  std::cout << "/*!" << std::endl
398
  std::cout << "/*!" << std::endl
399
	    << "\\ingroup core" << std::endl
399
	    << "\\ingroup constructs" << std::endl
400
	    << "\\defgroup GlobalValueList The list of all global values." << std::endl
400
	    << "\\defgroup GlobalValueList The list of all global values." << std::endl
401
	    << "<ul>" << std::endl;
401
	    << "<ul>" << std::endl;
402
  for (GlobalValue::Iterator i = GlobalValue::Begin (); i != GlobalValue::End (); ++i)
402
  for (GlobalValue::Iterator i = GlobalValue::Begin (); i != GlobalValue::End (); ++i)

Return to bug 1128