NEDDOC fixes

src/applications/generic/IIPvXTrafficGenerator.ned

@@ -20,7 +20,8 @@
 package inet.applications.generic;
 
 //
-// Prototype for modules that generate traffic directly over ~IP.
+// Prototype for modules that generate traffic directly over IP.
+// Compatible with both ~IPv4 and ~IPv6.
 //
 // @see ~IPvXTrafGen, ~IPvXTrafSink
 //

src/applications/generic/IPvXTrafGen.ned

@@ -25,7 +25,7 @@ package inet.applications.generic;
 // If the destAddresses parameter contains more than one address, one
 // of them is randomly for each packet. An address may be given in the
 // dotted decimal notation (or, for IPv6, in the usual notation with colons),
-// or with the module name. (The ~IPvXAddressResolver class is used to resolve
+// or with the module name. (The IPvXAddressResolver class is used to resolve
 // the address.) To disable the model, set destAddresses to "".
 //
 // The peer can be ~IPvXTrafSink or another ~IPvXTrafGen (it handles received packets

src/applications/generic/IPvXTrafSink.ned

@@ -20,8 +20,8 @@
 package inet.applications.generic;
 
 //
-// Consumes and prints packets received from the ~IP module.
-// Compatible with both IPv4 and IPv6.
+// Consumes and prints packets received from the IP module.
+// Compatible with both ~IPv4 and ~IPv6.
 //
 simple IPvXTrafSink like IIPvXTrafficGenerator
 {

src/applications/pingapp/PingApp.ned

@@ -25,7 +25,7 @@ package inet.applications.pingapp;
 // Start/stop time, sendInterval etc. can be specified via parameters. An address
 // may be given in the dotted decimal notation (or, for IPv6, in the usual
 // notation with colons), or with the module name.
-// (The ~IPvXAddressResolver class is used to resolve the address.)
+// (The IPvXAddressResolver class is used to resolve the address.)
 // To disable send, specify empty destAddr.
 //
 // Every ping request is sent out with a sequence number, and replies are
@@ -39,7 +39,7 @@ package inet.applications.pingapp;
 //
 // Uses ~PingPayload as payload for the ICMP(v6) Echo Request/Reply packets.
 //
-// @see ~PingPayload, ~ICMP, ~ICMPv6Core
+// @see ~PingPayload, ~ICMP, ~ICMPv6
 //
 simple PingApp
 {

src/applications/rtpapp/RTPApplication.ned

@@ -12,7 +12,7 @@ simple RTPApplication
  string commonName; // the common name (CNAME) of this host
  string profileName; // which rtp profile is to be used (usually RTPAVProfile)
  double bandwidth; // bandwidth in bytes per second for this session 
- string destinationAddress; // destination address (the ~IPvXAddressResolver class is used to resolve the address)
+ string destinationAddress; // destination address (the IPvXAddressResolver class is used to resolve the address)
  int portNumber; // used port
  string fileName; // fileName of file to be transmitted, "" means this system acts only as a receiver
  int payloadType; // payload type of file to transmit

src/applications/tcpapp/TelnetApp.ned

@@ -25,7 +25,7 @@ import inet.applications.ITCPApp;
 //
 // Models Telnet sessions with a specific user behaviour.
 // The server app should be ~TCPGenericSrvApp.
-// Compatible with both IPv4 (~IP) and ~IPv6.
+// Compatible with both ~IPv4 and ~IPv6.
 //
 // NOTE: This module emulates a very specific user behaviour, and as such,
 // it should be viewed as an example rather than a generic Telnet model.

src/applications/udpapp/UDPBasicApp.ned

@@ -24,7 +24,7 @@ import inet.applications.IUDPApp;
 
 //
 // Sends UDP packets to the given IP address at the given interval.
-// Compatible with both IPv4 (~IP) and ~IPv6.
+// Compatible with both ~IPv4 and ~IPv6.
 //
 // The sending interval can be a constant or a random value (e.g. exponential(1)).
 // If the destAddresses parameter contains more than one address, one

src/inet-doc.ned

@@ -33,7 +33,7 @@
 // Protocols are represented by simple modules. A simple module's external
 // interface (gates [connectors] and parameters) is described in a NED file,
 // and the implementation is contained in a C++ class with the same name.
-// Some examples: ~TCP, ~IP.
+// Some examples: ~TCP, ~IPv4.
 //
 // These modules can be freely combined to form hosts and other network devices
 // with the NED language (no C++ code and no recompilation required).
@@ -85,7 +85,7 @@
 //
 // - ~RoutingTable. This module contains the IP (v4) routing table, and heavily relies
 // on ~InterfaceTable for its operation. This module is also accessed from other
-// modules (typically ~IP) by calling the public member functions of its C++ class.
+// modules (typically ~IPv4) by calling the public member functions of its C++ class.
 // There are member functions for querying, adding, deleting routes, and
 // finding the best matching route for a given destination IP address.
 // The routing table submodule within the host (router) must be called

src/inet-index.ned

@@ -41,12 +41,11 @@
 // A few useful starting points for browsing the documentation:
 // - the <a href="full-ned-usage-diagram.html">Usage Diagram</a>
 // includes all modules and networks
-// - example networks: ~NClients, ~BulkTransfer, ~MulticastNetwork,
-// ~ARPTest, ~MixedLAN, etc.
+// - example networks: ~BulkTransfer, ~MulticastNetwork,
+// ~MixedLAN, etc.
 // - hosts, routers, switches: ~StandardHost, ~Router, ~EtherSwitch, ~EtherHub,
 // etc.
-// - network interfaces: ~EthernetInterface, ~PPPInterface, ~Ieee80211NicAdhoc,
-// ~Ieee80211NicSTA
+// - network interfaces: ~EthernetInterface, ~PPPInterface, ~Ieee80211Nic
 // - <a href="ieee80211.html">IEEE 802.11 models</a>, both ad-hoc and infrastructure
 // mode are supported
 // - IPv4 layer: ~IPv4, ~ARP and ~ICMP; ~RoutingTable
@@ -65,7 +64,7 @@
 // ~ARPPacket, ~PPPFrame, ~GenericAppMsg, ~EtherAppReq, etc.
 // - control info classes (used in communication between protocol layers):
 // ~IPv4ControlInfo, ~TCPCommand, ~UDPControlInfo, ~Ieee802Ctrl, etc.
-// - application models: ~UDPVideoStreamSvr, ~UDPVideoStreamCli, ~UDPApp,
+// - application models: ~UDPVideoStreamSvr, ~UDPVideoStreamCli, ~UDPBasicApp, ~UDPEchoApp,
 // ~TCPSessionApp, ~TCPBasicClientApp, ~TCPGenericSrvApp, ~TCPSinkApp,
 // ~TCPSrvHostApp, ~EtherAppCli, ~EtherAppSrv, ~PingApp, etc.
 // - wireless support: ~ChannelControl, ~Nic80211
@@ -74,12 +73,10 @@
 // - MPLS models: the core modules are ~MPLS, ~LIBTable, ~LDP, ~RSVP, ~TED,
 // ~LinkStateRouting; MPLS-enabled routers are ~LDP_LSR, ~RSVP_LSR;
 // see also the list of <a href="standards.html">implemented standards</a>
-// - dynamic routing is provided by the ~Daemon module (the Quagga routing
-// daemon ported into the INET Framework) used inside ~QuaggaRouter;
-// alternatively one can run ~OSPFRouter which relies on the ~OSPFRouting
-// module;
-// - support for recording <i>nam</i> traces is provided by ~NAMTrace and
-// ~NAMTraceWriter
+// - dynamic routing is provided by the Daemon module (the Quagga routing
+// daemon ported into the INET Framework, currently in a different project)
+// used inside QuaggaRouter; alternatively one can run ~OSPFRouter which relies
+// on the ~OSPFRouting module;
 //
 // Related documentation:
 // - <a href="../doxy/index.html" target="_top">C++ source documentation (Doxygen)</a>

src/linklayer/contract/Ieee802Ctrl.msg

@@ -74,5 +74,5 @@ class Ieee802Ctrl
  int ssap; // used with IEEE 802 LLC (see ~EtherFrameWithLLC)
  int dsap; // used with IEEE 802 LLC (see ~EtherFrameWithLLC)
  int pauseUnits; // used with IEEE802CTRL_SENDPAUSE
- int inputPort; // convenience field, used between ~IPv6 and ~IPv6NeighborDiscovery
+ int inputPort; // convenience field, used between ~IPv6 and ~IPv6NeighbourDiscovery
 }

src/linklayer/ethernet/EtherMAC.ned

@@ -86,7 +86,7 @@ import inet.linklayer.IEtherMAC;
 //
 // <b>Queueing</b>
 //
-// In routers, MAC relies on an external queue module (see ~OutputQueue)
+// In routers, MAC relies on an external queue module (see ~IOutputQueue)
 // to model finite buffer, implement QoS and/or RED, and requests packets
 // from this external queue one-by-one.
 //

src/linklayer/ethernet/EthernetInterface.ned

@@ -30,14 +30,12 @@ import inet.base.IHook;
 // Ethernet network interface. Complements ~EtherMAC and ~EtherEncap
 // with an output queue for QoS and RED support.
 //
-// @see EthernetInterface2, ~EthernetInterfaceNoQueue
-//
 module EthernetInterface like IWiredNic
 {
  parameters:
  bool csmacdSupport = default(false); // by default no CSMA/CD so only only point-to-point duplex links are supported.
  string macType = default(csmacdSupport ? "EtherMAC" : "EtherMACFullDuplex"); // ~EtherMAC or ~EtherMACFullDuplex
- string queueType = default("DropTailQueue"); // DropTailQueue, DropTailQoSQueue, REDQueue, NoQueue
+ string queueType = default("DropTailQueue"); // ~DropTailQueue, ~DropTailQoSQueue, ~REDQueue, NoQueue
  int numOutputHooks = default(0);
  int numInputHooks = default(0);
  @display("i=block/ifcard;bgb=273,285;bgl=2");

src/linklayer/ieee80211/Ieee80211Doc.ned

@@ -26,9 +26,9 @@
 // access point) and their level of detail:
 //
 // - ~Ieee80211Nic: a generic (configurable) NIC
-// - ~Ieee80211NicAdhoc: for ad-hoc mode
-// - ~Ieee80211NicAP, ~Ieee80211NicAPSimplified: for use in an access point
-// - ~Ieee80211NicSTA, ~Ieee80211NicSTASimplified: for use in an
+// - ~Ieee80211Nic with mgmtType = ~Ieee80211MgmtAdhoc: for ad-hoc mode
+// - ~Ieee80211Nic with mgmtType = ~Ieee80211MgmtAP or ~Ieee80211MgmtAPSimplified: for use in an access point
+// - ~Ieee80211Nic with mgmtType = ~Ieee80211MgmtSTA, ~Ieee80211MgmtSTASimplified: for use in an
 // infrastructure-mode station
 //
 // NICs consist of four layers, which are the following (in top-down order):
@@ -72,7 +72,8 @@
 // just carries out these commands by performing the scanning, authentication
 // and association procedures, and reports back the results to the agent.
 //
-// The agent layer is currenly only present in the ~Ieee80211NicSTA NIC module,
+// The agent layer is currenly only present in the ~Ieee80211Nic with
+// mgmtType = ~Ieee80211MgmtSTA NIC module,
 // as an ~Ieee80211AgentSTA module. The managament entities in other NIC
 // variants do not have as much freedom as to need an agent to control them.
 //

src/linklayer/ppp/PPPInterface.ned

@@ -28,13 +28,11 @@ import inet.base.IHook;
 // PPP interface. Complements the ~PPP module with an output queue
 // for QoS and RED support.
 //
-// @see ~PPPInterfaceNoQueue
-//
 module PPPInterface like IWiredNic
 {
  parameters:
  @display("i=block/ifcard;bgb=214,249");
- string queueType = default("DropTailQueue"); // DropTailQueue, DropTailQoSQueue, REDQueue, NoQueue
+ string queueType = default("DropTailQueue"); // ~DropTailQueue, ~DropTailQoSQueue, ~REDQueue, NoQueue
  int numOutputHooks = default(0);
  int numInputHooks = default(0);
  gates:

src/networklayer/extras/FailureManager.ned

@@ -41,8 +41,7 @@ package inet.networklayer.extras;
 //
 // - <code>shutdown</code>: replaces a router module named by the <tt>target</tt> attribute
 // with another module that represents a failed router. It currently replaces
-// ~RSVP_LSR with ~RSVP_FAILED, ~LDP_LSR with ~LDP_FAILED, and ~QuaggaRouter with
-// ~FailedRouter.
+// ~RSVP_LSR with ~RSVP_FAILED, ~LDP_LSR with ~LDP_FAILED.
 // - <code>startup</code>: the inverse of <tt>shutdown</tt>: replaces a <i>failed</i>
 // router model named by the <tt>target</tt> attribute with an operational host/router
 // module type.

src/networklayer/manetrouting/OLSR_ETX.ned

@@ -35,7 +35,7 @@ import inet.networklayer.IManetRouting;
 // - IPv4 address size is assumed in the messages. If you need IPv6, recompile with -DOLSR_IPv6 added to CFLAGS 
 // - Multiple interfaces per OLSR node is supported only with adding -DMULTIPLE_IFACES_SUPPORT to CFLAGS
 //
-// see: <a>http://www.inf.ufrgs.br/~wlccordeiro/resources/olsr/README.html</a>
+// see: <a>http://www.inf.ufrgs.br/~~wlccordeiro/resources/olsr/README.html</a>
 //
 simple OLSR_ETX extends BaseRouting like IManetRouting
 {

src/networklayer/mpls/MPLS.ned

@@ -25,7 +25,7 @@ package inet.networklayer.mpls;
 //
 // Operations
 //
-// MPLS packets are represented by the ~MPLSPacket class.
+// MPLS packets are represented by the MPLSPacket class.
 // The local LIB (Label Information Base) is stored in a ~LIBTable module
 // in the LSR.
 //

src/nodes/inet/Router.ned

@@ -31,9 +31,8 @@ package inet.nodes.inet;
 // modules implementing ~IWirelessNic
 // - Also external interfaces can be configured for HW in the loop simulation
 // using the numExtInterfaces parameter and setting the type using
-// **.ext.typename in the INI file. see: ~ExtInerface and ~IExternalNic
-// - PPP interface type can be set using **.ppp.typename see: ~PPPInterface
-// and ~PPPInterfaceNoQueue
+// **.ext.typename in the INI file. see: ~ExtInterface and ~IExternalNic
+// - PPP queueing type can be set using **.ppp.queueType, see: ~PPPInterface
 // - If wireless card is present, node mobility can be set using **.mobility.typename
 // see: inet.mobility and ~IMobility
 //

src/nodes/inet/StandardHost.ned

@@ -40,9 +40,7 @@ import inet.applications.ISCTPApp;
 // modules implementing ~IWirelessNic
 // - Also external interfaces can be configured for HW in the loop simulation
 // using the numExtInterfaces parameter and setting the type using
-// **.ext[*].typename in the INI file. see: ~ExtInerface and ~IExternalNic
-// - PPP interface type can be set using **.ppp[*].typename see: ~PPPInterface
-// and ~PPPInterfaceNoQueue
+// **.ext[*].typename in the INI file. see: ~ExtInterface and ~IExternalNic
 // - If wireless card is present, node mobility can be set using **.mobilityType
 // see: inet.mobility and ~IMobility
 //

src/nodes/inet/WirelessHost.ned

@@ -18,14 +18,11 @@
 package inet.nodes.inet;
 
 //
-// Models a host with one wireless (802.11) card in infrastructure mode.
-// This module is basically a ~StandardHost with an ~Ieee80211NicSTA added.
-// It should be used in conjunction with ~WirelessAP, or any other AP model
-// which contains ~Ieee80211NicAP.
-//
-// @see ~WirelessAP, ~WirelessAPSimplified, ~WirelessAPWithEth, ~WirelessAPWithEthSimplified
-// @see ~WirelessHost, ~WirelessHostSimplified
-// @see ~MobileHost, ~MFMobileHost
+// Models a host with (default) one wireless (802.11) card in infrastructure mode.
+// This module is basically a ~StandardHost with an ~Ieee80211Nic with
+// mgmtType = ~Ieee80211MgmtSTA added.
+// It should be used in conjunction with ~AccessPoint, or any other AP model
+// which contains ~Ieee80211Nic with mgmtType = ~Ieee80211MgmtAP.
 //
 module WirelessHost extends StandardHost
 {

src/nodes/wireless/AccessPoint.ned

@@ -27,12 +27,12 @@ import inet.base.NotificationBoard;
 // multiple ethernet ports. The type of the ethernet MAC, relay Unit
 // and wireless card can be specified as parameters.
 //
-// By default the access point is stationary (StationaryMobility), but can be
+// By default the access point is stationary (~StationaryMobility), but can be
 // changed also if needed.
 //
 // The wlan[*].mgmtType can be configured for different management types
-// currently it can be: Ieee80211MgmtAPSimplified and Ieee80211MgmtAP.
-// By default it is Ieee80211MgmtAP. The Simplified version does not 
+// currently it can be: ~Ieee80211MgmtAPSimplified and ~Ieee80211MgmtAP.
+// By default it is ~Ieee80211MgmtAP. The Simplified version does not 
 // support channel scanning, authentication and association . 
 // In this case nodes must explicitly specify the hardware address
 // of the Wlan card they want to be associated with. 

src/transport/sctp/contract/SCTPCommand.msg

@@ -76,7 +76,7 @@ class SCTPErrorInfo extends SCTPCommand
 // Control info to be used for active or passive ~SCTP open.
 //
 // localAddr, remoteAddr, localPort, remotePort should be self-explanatory.
-// localAddr is optional because ~SCTP can learn it from ~IP when a packet
+// localAddr is optional because ~SCTP can learn it from IP when a packet
 // is received from the peer; localPort is optional because ~SCTP supports
 // ephemeral ports.
 //

src/transport/tcp/TCP.ned

@@ -40,7 +40,7 @@ import inet.transport.ITCP;
 // Algorithm for TCP
 // - RFC 3782 - The NewReno Modification to TCP's Fast Recovery Algorithm
 //
-// This module is compatible with both IPv4 (~IP) and ~IPv6.
+// This module is compatible with both ~IPv4 and ~IPv6.
 //
 // A TCP segment is represented by the class ~TCPSegment.
 //
@@ -193,7 +193,7 @@ import inet.transport.ITCP;
 //
 // <b>Tests</b>
 //
-// There are automated test cases (*.test files) for TCP -- see the ~Test
+// There are automated test cases (*.test files) for TCP -- see the <i>tests</i>
 // directory in the source distribution.
 //
 // Please also see ChangeLog.

src/transport/tcp_common/contract/TCPCommand.msg

@@ -123,7 +123,7 @@ enum TCPDataTransferMode
 // Control info to be used for active or passive TCP open.
 //
 // localAddr, remoteAddr, localPort, remotePort should be self-explanatory.
-// localAddr is optional because TCP can learn it from ~IP when a packet
+// localAddr is optional because TCP can learn it from IP when a packet
 // is received from the peer; localPort is optional because TCP supports
 // ephemeral ports.
 //