ns3dev merge

doc/doxygen.conf

@@ -300,7 +300,7 @@ HIDE_UNDOC_MEMBERS     = YES
 # If set to NO (the default) these classes will be included in the various 
 # overviews. This option has no effect if EXTRACT_ALL is enabled.
 
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
 # friend (class|struct|union) declarations. 

src/devices/l2-routing/l2-routing-hwmp/hwmp-rtable.h

@@ -32,7 +32,9 @@
 #include "ns3/packet.h"
 namespace ns3 {
 
-
+/**
+ * \ingroup mesh
+ */
 	class HwmpRtable : public Object
 	{
 		public:

src/devices/l2-routing/l2-routing-hwmp/hwmp-state.h

@@ -34,7 +34,10 @@
 #include "ns3/dot11s-parameters.h"
 namespace ns3 {
 	/**
+	 * \ingroup mesh
+	 * 
 	 * \brief Handles HWMP state machine at each real interface
+	 * 
 	 * \details Implements the following:
 	 * 	1. Keep it's own DSN,
 	 * 	2. Keep PREQ and PREP timers adn send this frames in

src/devices/l2-routing/l2-routing-hwmp/hwmp.h

@@ -35,8 +35,11 @@
 namespace ns3 {
 	class HwmpState;
 	/**
+	 * \ingroup mesh
+	 * 
 	 * \brief Hwmp tag implements interaction between HWMP
 	 * protocol and MeshWifiMac
+	 * 
 	 * \details Hwmp tag keeps the following:
 	 * 1. When packet is passed from Hwmp to 11sMAC:
 	 * 	- retransmitter address,
@@ -75,6 +78,9 @@ namespace ns3 {
 			uint32_t	m_metric;
 			uint32_t	m_seqno;
 	};
+	/**
+	 * \ingroup mesh
+	 */
 	class Hwmp : public L2RoutingProtocol
 	{
 		public:

src/devices/l2-routing/l2-routing-main/l2-routing-net-device.h

@@ -32,17 +32,16 @@
 namespace ns3 {
 	class Node;
 	/**
-	 * \ingroup devices
-	 * \defgroup L2RoutingNetDevice L2routingNetDevice
-	 */
-	/**
-	 * \ingroup L2RoutingNetDevice
+	 * \ingroup mesh
+	 * 
 	 * \brief a virtual net device that may forward packets
 	 * between real network devices using routing protocols of
 	 * MAC-layer
+	 * 
 	 * \details This is a virtual netdevice, which aggreagates
 	 * real netdevices and uses interface of L2RoutingProtocol to
 	 * forward packets
+	 * 
 	 * \attention The idea of L2RoutingNetDevice is similar to
 	 * BridgeNetDevice, but the packets, which going through
 	 * L2RoutingNetDevice may be changed (because routing protocol

src/devices/wifi/dot11s-codes.h

@@ -25,6 +25,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup mesh
+ */
 enum dot11sElementID {
 	IE11S_MESH_CONFIGURATION = 18,
 	IE11S_MESH_ID,
@@ -52,6 +55,9 @@ enum dot11sElementID {
 	IE11S_MSAIE,
 };
 
+/**
+ * \ingroup mesh
+ */
 enum dot11sReasonCode {
 	REASON11S_PEER_LINK_CANCELLED,
 	REASON11S_MESH_MAX_PEERS,
@@ -69,6 +75,9 @@ enum dot11sReasonCode {
 	REASON11S_RESERVED,
 };
 
+/**
+ * \ingroup mesh
+ */
 enum dot11sStatusCode {
 	STATUS11S_PEAR_LINK_ESTABLISHED,
 	STATUS11S_PEAR_LINK_CLOSED,

src/devices/wifi/dot11s-parameters.h

@@ -31,6 +31,9 @@ namespace ns3
 #define TU_TO_TIME(x)	MicroSeconds(x*1024)
 #define TIME_TO_TU(x)	x.GetMicroSeconds()/1024
 
+/**
+  * \ingroup mesh
+*/
 struct dot11sParameters
 {
 	/** Peer Link  */

src/devices/wifi/dot11s-peer-management-element.h

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

src/devices/wifi/mesh-configuration-element.h

@@ -29,31 +29,41 @@
 
 namespace ns3
 {
-
+  /**
+   * \ingroup mesh
+   */
 enum dot11sPathSelectionProtocol
 {
   PROTOCOL_HWMP = 0x000fac00,
   PROTOCOL_NULL = 0x000facff,
 };
-
+/**
+ * \ingroup mesh
+ */
 enum dot11sPathSelectionMetric
 {
   METRIC_AIRTIME = 0x000fac00,
   METRIC_NULL    = 0x000facff,
 };
-
+/**
+ * \ingroup mesh
+ */
 enum dot11sCongestionControlMode
 {
   CONGESTION_DEFAULT = 0x000fac00,
   CONGESTION_NULL    = 0x000facff,
 };
-
+/**
+ * \ingroup mesh
+ */
 enum dot11sChannelPrecedence 
 {
   CHANNEL_PRECEDENCE_OFF = 0x000fac00,
 };
 
-
+/**
+ * \ingroup mesh
+ */
 class dot11sMeshCapability
 {
   public:
@@ -71,6 +81,9 @@ class dot11sMeshCapability
   bool Is(uint16_t cap,uint8_t n) const;
 };
 
+/**
+ * \ingroup mesh
+ */
 class MeshConfigurationElement
 {
 	public:

src/devices/wifi/mesh-mgt-headers.h

@@ -42,6 +42,9 @@
 #include "ssid.h"
 
 namespace ns3 {
+/**
+ * \ingroup mesh
+ */
 class MgtMeshBeaconHeader : public MgtBeaconHeader
 {
 	public:
@@ -59,6 +62,9 @@ class MgtMeshBeaconHeader : public MgtBeaconHeader
 
 };
 
+/**
+ * \ingroup mesh
+ */
 class MeshMgtPeerLinkManFrame :	public Header
 {
 	public:

src/devices/wifi/mesh-wifi-beacon-timing-element.h

@@ -29,6 +29,9 @@
 #include "dot11s-codes.h"
 namespace ns3
 {
+/**
+ * \ingroup mesh
+ */
 class WifiBeaconTimingElementUnit : public RefCountBase
 {
 	public:
@@ -49,10 +52,20 @@ class WifiBeaconTimingElementUnit : public RefCountBase
 		//Beacon interval of remote mesh point:
 		uint16_t	BeaconInterval;
 };
-//This type is a list of timing elements obtained from neigbours with their beacons:
+/**
+ * \ingroup mesh
+ * This type is a list of timing elements obtained from neigbours with their beacons:
+ */
 typedef Ptr<WifiBeaconTimingElementUnit>		WifiBeaconTimingElementPointer;
+
+/**
+ * \ingroup mesh
+ */
 typedef std::list<WifiBeaconTimingElementPointer>	NeighboursTimingUnitsList;
 
+/**
+ * \ingroup mesh
+ */
 class WifiBeaconTimingElement
 {
 	public:

src/devices/wifi/mesh-wifi-mac-header.h

@@ -7,7 +7,9 @@
 #include <stdint.h>
 
 namespace ns3 {
-
+/**
+ * \ingroup mesh
+ */
 class WifiMeshHeader : public Header //7.1.3.5b
 {
 	public:
@@ -44,6 +46,10 @@ class WifiMeshHeader : public Header //7.1.3.5b
 		Mac48Address	m_addr6;
 		Mac48Address	m_addr7;
 };
+
+/**
+ * \ingroup mesh
+ */
 class WifiMeshMultihopActionHeader : public Header //7.2.3.14
 {
 	//Multichop action frame consists of Mesh header, Action, and

src/devices/wifi/mesh-wifi-mac.h

@@ -18,11 +18,6 @@
  * Authors: Kirill Andreev <andreev@iitp.ru>
  *          Evgeny Khorov <horov@frtk.ru>
  */
-
-/**
- * \addtogroup mesh
- * \{
- */
 #ifndef MAC_HIGH_MESH_H
 #define MAC_HIGH_MESH_H
 
@@ -51,6 +46,7 @@ namespace ns3 {
 	class WifiPeerManager;
 	/**
 	 * \ingroup mesh
+	 * 
 	 * \brief Implements MAC-layer of mesh point: beaconing and
 	 * peer link management.
 	 *
@@ -388,4 +384,4 @@ namespace ns3 {
 
 
 #endif /* MAC_HIGH_MESH_H */
-//\}
+/*@}*/

src/devices/wifi/mesh-wifi-peer-manager.h

@@ -39,6 +39,9 @@
 namespace ns3
 {
 	class MeshWifiMac;
+	/**
+	 * \ingroup mesh
+	 */
 	class WifiPeerLinkDescriptor : public RefCountBase
 	{
 		public:
@@ -191,7 +194,9 @@ namespace ns3
 			Callback<void, Mac48Address, Mac48Address, bool>
 					m_linkStatusCallback;
 	};
-
+	/**
+	 * \ingroup mesh
+	 */
 	class WifiPeerManager : public Object
 	{
 		public:

src/devices/wifi/mesh-wifi-perr-information-element.h

@@ -33,7 +33,9 @@
 
 namespace ns3
 {
-
+/**
+ * \ingroup mesh
+ */
 class WifiPerrInformationElement : public Header
 {
 	public:

src/devices/wifi/mesh-wifi-prep-information-element.h

@@ -32,6 +32,9 @@
 #include	"dot11s-codes.h"
 namespace ns3
 {
+/**
+ * \ingroup mesh
+ */
 class WifiPrepInformationElement : public Header
 {
 	public:

src/devices/wifi/mesh-wifi-preq-information-element.h

@@ -32,6 +32,9 @@
 #include 	"dot11s-codes.h"
 namespace ns3
 {
+/**
+ * \ingroup mesh
+ */
 class DestinationAddressUnit : public RefCountBase
 {
 	public:
@@ -51,7 +54,9 @@ class DestinationAddressUnit : public RefCountBase
 		Mac48Address m_destinationAddress;
 		uint32_t m_destSeqNumber;
 };	
-
+/**
+ * \ingroup mesh
+ */
 class WifiPreqInformationElement : public Header
 {
 	public:

src/devices/wifi/mesh-wifi-rann-information-element.h

@@ -33,6 +33,9 @@
 
 namespace ns3
 {
+/**
+ * \ingroup mesh
+ */
 class WifiRannInformationElement
 {
 	public:

src/node/l2-routing-protocol.h

@@ -34,11 +34,7 @@ namespace ns3 {
 
 class Packet;
 /**
- * \ingroup node
- * \defgroup L2RoutingProtocol L2routingProtocol
- */
-/**
- * \ingroup L2RoutingProtocol
+ * \ingroup mesh
  *
  * \brief Base class for Layer 2 routing protocols
  *