NED: also removed "This is..." from the docu briefs

avarga · avarga · commit 2840d8b9978d · 2025-03-18T22:36:02.000+01:00
diff --git a/src/inet/clock/base/ClockBase.ned b/src/inet/clock/base/ClockBase.ned
@@ -8,7 +8,7 @@
 package inet.clock.base;
 
 //
-// This is a base module for clocks.
+// Base module for clocks.
 //
 module ClockBase
 {
diff --git a/src/inet/clock/base/DriftingOscillatorBase.ned b/src/inet/clock/base/DriftingOscillatorBase.ned
@@ -8,7 +8,7 @@
 package inet.clock.base;
 
 //
-// This is a base module for oscillators that drift relative to the nominal tick
+// Base module for oscillators that drift relative to the nominal tick
 // length over time.
 //
 simple DriftingOscillatorBase extends OscillatorBase
diff --git a/src/inet/clock/base/OscillatorBase.ned b/src/inet/clock/base/OscillatorBase.ned
@@ -8,7 +8,7 @@
 package inet.clock.base;
 
 //
-// This is a base module for oscillators.
+// Base module for oscillators.
 //
 simple OscillatorBase
 {
diff --git a/src/inet/mobility/single/SuperpositioningMobility.ned b/src/inet/mobility/single/SuperpositioningMobility.ned
@@ -11,8 +11,8 @@ import inet.mobility.base.MobilityBase;
 import inet.mobility.contract.IMobility;
 
 //
-// This mobility module combines the trajectory of several other mobility modules
-// using superposition. In other words, the position, velocity, and acceleration
+// Combines the trajectory of several other mobility modules using superposition.
+// In other words, the position, velocity, and acceleration
 // are the sum of the respective quantities of all submodules.
 //
 // This module allows forming a group mobility model by using a shared mobility
diff --git a/src/inet/mobility/static/StationaryMobility.ned b/src/inet/mobility/static/StationaryMobility.ned
@@ -10,7 +10,7 @@ package inet.mobility.static;
 import inet.mobility.base.MobilityBase;
 
 //
-// This mobility module does nothing; it can be used for stationary nodes.
+// Mobility module for stationary nodes.
 //
 simple StationaryMobility extends MobilityBase
 {
diff --git a/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned
@@ -10,7 +10,7 @@ package inet.physicallayer.wireless.common.antenna;
 import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase;
 
 //
-// This model is based on a parabolic approximation of the main lobe radiation
+// Defines an antenna based on a parabolic approximation of the main lobe radiation
 // pattern. A similar model appears in
 //
 // George Calcev and Matt Dillon, "Antenna Tilt Control in CDMA Networks"
diff --git a/src/inet/queueing/base/ActivePacketSinkBase.ned b/src/inet/queueing/base/ActivePacketSinkBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various active packet sink modules.
+// Base module for various active packet sink modules.
 //
 // @see ~PacketSinkBase
 //
diff --git a/src/inet/queueing/base/ActivePacketSourceBase.ned b/src/inet/queueing/base/ActivePacketSourceBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various active packet source modules.
+// Base module for various active packet source modules.
 //
 // @see ~PacketSourceBase
 //
diff --git a/src/inet/queueing/base/PacketBufferBase.ned b/src/inet/queueing/base/PacketBufferBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet buffer modules which maintains a few
+// Base module for various packet buffer modules which maintains a few
 // statistics.
 //
 // Available display string format directives:
diff --git a/src/inet/queueing/base/PacketClassifierBase.ned b/src/inet/queueing/base/PacketClassifierBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet classifier modules. Derived modules
+// Base module for various packet classifier modules. Derived modules
 // must implement a single packet classifier function which determines the index
 // of the output gate for the next pushed packet.
 //
diff --git a/src/inet/queueing/base/PacketFilterBase.ned b/src/inet/queueing/base/PacketFilterBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet filter modules. Derived modules must
+// Base module for various packet filter modules. Derived modules must
 // implement a single packet matcher function which determines if a packet is to
 // be passed through or filtered out.
 //
diff --git a/src/inet/queueing/base/PacketFlowBase.ned b/src/inet/queueing/base/PacketFlowBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet flow modules. A packet flow module
+// Base module for various packet flow modules. A packet flow module
 // passes or streams all pushed or pulled packets after processing them from
 // its input to its output.
 //
diff --git a/src/inet/queueing/base/PacketGateBase.ned b/src/inet/queueing/base/PacketGateBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet gate modules.
+// Base module for various packet gate modules.
 //
 // @see ~IPacketGate
 //
diff --git a/src/inet/queueing/base/PacketLabelerBase.ned b/src/inet/queueing/base/PacketLabelerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet labeler modules.
+// Base module for various packet labeler modules.
 //
 simple PacketLabelerBase extends PacketMarkerBase
 {
diff --git a/src/inet/queueing/base/PacketMarkerBase.ned b/src/inet/queueing/base/PacketMarkerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet marker modules. Derived modules must
+// Base module for various packet marker modules. Derived modules must
 // implement a single `markPacket()` function which marks the individual packets
 // by attaching tags.
 //
diff --git a/src/inet/queueing/base/PacketMeterBase.ned b/src/inet/queueing/base/PacketMeterBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet meter modules. Derived modules must
+// Base module for various packet meter modules. Derived modules must
 // implement a single `meterPacket()` function which meters the flow of and attaches
 // the required tags.
 //
diff --git a/src/inet/queueing/base/PacketProcessorBase.ned b/src/inet/queueing/base/PacketProcessorBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet processing modules which maintains
+// Base module for various packet processing modules which maintains
 // a few statistics.
 //
 // Available display string text format directives:
diff --git a/src/inet/queueing/base/PacketPullerBase.ned b/src/inet/queueing/base/PacketPullerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet puller modules.
+// Base module for various packet puller modules.
 //
 simple PacketPullerBase extends PacketProcessorBase
 {
diff --git a/src/inet/queueing/base/PacketPusherBase.ned b/src/inet/queueing/base/PacketPusherBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet pusher modules.
+// Base module for various packet pusher modules.
 //
 simple PacketPusherBase extends PacketProcessorBase
 {
diff --git a/src/inet/queueing/base/PacketQueueBase.ned b/src/inet/queueing/base/PacketQueueBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet queue modules which maintains a few
+// Base module for various packet queue modules which maintains a few
 // statistics.
 //
 // Available display string format directives:
diff --git a/src/inet/queueing/base/PacketSchedulerBase.ned b/src/inet/queueing/base/PacketSchedulerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet scheduler modules. Derived modules
+// Base module for various packet scheduler modules. Derived modules
 // must implement a single packet scheduler function which determines the index
 // of the input gate for the pulled packet.
 //
diff --git a/src/inet/queueing/base/PacketServerBase.ned b/src/inet/queueing/base/PacketServerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet server modules.
+// Base module for various packet server modules.
 //
 // @see ~IPacketServer
 //
diff --git a/src/inet/queueing/base/PacketSinkBase.ned b/src/inet/queueing/base/PacketSinkBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet sink modules.
+// Base module for various packet sink modules.
 //
 // @see ~IPacketSink
 //
diff --git a/src/inet/queueing/base/PacketSourceBase.ned b/src/inet/queueing/base/PacketSourceBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet source modules. Packets are created
+// Base module for various packet source modules. Packets are created
 // randomly with regard to packet length and packet data. The representation of
 // packet data can also be configured.
 //
diff --git a/src/inet/queueing/base/PacketTaggerBase.ned b/src/inet/queueing/base/PacketTaggerBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various packet tagger modules.
+// Base module for various packet tagger modules.
 //
 simple PacketTaggerBase extends PacketMarkerBase
 {
diff --git a/src/inet/queueing/base/PassivePacketSinkBase.ned b/src/inet/queueing/base/PassivePacketSinkBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various active packet sink modules.
+// Base module for various active packet sink modules.
 //
 // @see ~PacketSinkBase
 //
diff --git a/src/inet/queueing/base/PassivePacketSourceBase.ned b/src/inet/queueing/base/PassivePacketSourceBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various active packet source modules.
+// Base module for various active packet source modules.
 //
 // @see ~PacketSourceBase
 //
diff --git a/src/inet/queueing/base/TokenGeneratorBase.ned b/src/inet/queueing/base/TokenGeneratorBase.ned
@@ -8,7 +8,7 @@
 package inet.queueing.base;
 
 //
-// This is a base module for various token generator modules.
+// Base module for various token generator modules.
 //
 simple TokenGeneratorBase extends PacketProcessorBase
 {
diff --git a/src/inet/visualizer/base/DataLinkVisualizerBase.ned b/src/inet/visualizer/base/DataLinkVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for data link layer link visualizer simple modules. It
+// Base module for data link layer link visualizer simple modules. It
 // keeps track of active links in a network. A link between two network nodes is
 // considered active if a packet is sent recently between their link layers.
 // Active links are not displayed by default, see the module parameters for how
diff --git a/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned b/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for energy storage visualizer simple modules.
+// Base module for energy storage visualizer simple modules.
 //
 // @see ~EnergyStorageCanvasVisualizer, ~EnergyStorageOsgVisualizer, ~IEnergyStorageVisualizer, ~VisualizerBase
 //
diff --git a/src/inet/visualizer/base/GateScheduleVisualizerBase.ned b/src/inet/visualizer/base/GateScheduleVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for gate visualizer simple modules.
+// Base module for gate visualizer simple modules.
 //
 // Format string directives:
 //	- %i: interface name
diff --git a/src/inet/visualizer/base/Ieee80211VisualizerBase.ned b/src/inet/visualizer/base/Ieee80211VisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for IEEE 802.11 association visualizer simple modules.
+// Base module for IEEE 802.11 association visualizer simple modules.
 // It keeps track of wireless interface associations by subscribing to a number
 // of signals at the provided subscription module.
 //
diff --git a/src/inet/visualizer/base/InfoVisualizerBase.ned b/src/inet/visualizer/base/InfoVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for submodule information visualizer simple modules.
+// Base module for submodule information visualizer simple modules.
 // It displays some information on network nodes originating from one of their
 // corresponding submodules. No information is displayed by default, see module
 // parameters for how to enable the visualization. The actual visualization is
diff --git a/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned b/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for interface table visualizer simple modules.
+// Base module for interface table visualizer simple modules.
 // It displays information of network interfaces at network nodes. Network
 // interfaces are not displayed by default, see module parameters for how to
 // enable the visualization.
diff --git a/src/inet/visualizer/base/LinkBreakVisualizerBase.ned b/src/inet/visualizer/base/LinkBreakVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for link break visualizer simple modules. It keeps
+// Base module for link break visualizer simple modules. It keeps
 // track of link breaks in a network. Link breaks are not displayed by
 // default, see module parameters for how to enable the visualization. The
 // actual visualization of link breaks is done in derived modules.
diff --git a/src/inet/visualizer/base/LinkVisualizerBase.ned b/src/inet/visualizer/base/LinkVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for link visualizer simple modules. It keeps track of
+// Base module for link visualizer simple modules. It keeps track of
 // active links in a network. A link between two network nodes is considered
 // active if a packet has been sent recently between the corresponding layers. Active
 // links are not displayed by default, see the module parameters for how to
diff --git a/src/inet/visualizer/base/MediumVisualizerBase.ned b/src/inet/visualizer/base/MediumVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for medium visualizer simple modules. It keeps track
+// Base module for medium visualizer simple modules. It keeps track
 // of ongoing signal departures, ongoing signal arrivals, and propagating signals.
 //
 // It subscribes to `signalSourceAdded`, `signalSourceRemoved`, `signalAdded`,
diff --git a/src/inet/visualizer/base/MobilityVisualizerBase.ned b/src/inet/visualizer/base/MobilityVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for mobility visualizer simple modules. It subscribes
+// Base module for mobility visualizer simple modules. It subscribes
 // to the `mobilityStateChanged` signal in the module determined by the
 // `visualizationSubjectModule` parameter. The actual visualization of mobility is done in
 // derived modules.
diff --git a/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned b/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for connection visualizer simple modules. The actual
+// Base module for connection visualizer simple modules. The actual
 // visualization of network connections is done in derived modules.
 //
 // @see ~NetworkConnectionCanvasVisualizer, ~NetworkConnectionOsgVisualizer, ~INetworkConnectionVisualizer, ~VisualizerBase
diff --git a/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned b/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for node visualizer simple modules. The actual
+// Base module for node visualizer simple modules. The actual
 // visualization of network nodes is done in derived modules.
 //
 // @see ~NetworkNodeCanvasVisualizer, ~NetworkNodeOsgVisualizer, ~INetworkNodeVisualizer, ~VisualizerBase
diff --git a/src/inet/visualizer/base/PacketDropVisualizerBase.ned b/src/inet/visualizer/base/PacketDropVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for packet drop visualizer simple modules. It keeps
+// Base module for packet drop visualizer simple modules. It keeps
 // track of dropped packets in a network. Packet drops are not displayed by
 // default, see module parameters for how to enable the visualization. The
 // actual visualization of packet drops is done in derived modules.
diff --git a/src/inet/visualizer/base/PathVisualizerBase.ned b/src/inet/visualizer/base/PathVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for path visualizer simple modules. It keeps track of
+// Base module for path visualizer simple modules. It keeps track of
 // active routes in a network. A route between two nodes is considered active
 // if a packet is sent recently between their corresponding layers. Active
 // routes are not displayed by default, see the module parameters for how to
diff --git a/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned b/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for physical environment visualizer simple modules. It
+// Base module for physical environment visualizer simple modules. It
 // provides the physical objects through the physical environment module for
 // derived modules. The actual visualization of physical objects is done in
 // derived modules.
diff --git a/src/inet/visualizer/base/PhysicalLinkVisualizerBase.ned b/src/inet/visualizer/base/PhysicalLinkVisualizerBase.ned
@@ -8,7 +8,7 @@
 package inet.visualizer.base;
 
 //
-// This is a base module for physical layer link visualizer simple modules. It
+// Base module for physical layer link visualizer simple modules. It
 // keeps track of active links in a network. A link between two network nodes is
 // considered active if a packet is sent recently between their physical layers.
 // Active links are not displayed by default, see the module parameters for how
diff --git a/src/inet/visualizer/base/QueueVisualizerBase.ned b/src/inet/visualizer/base/QueueVisualizerBase.ned
diff --git a/src/inet/visualizer/base/RadioVisualizerBase.ned b/src/inet/visualizer/base/RadioVisualizerBase.ned
diff --git a/src/inet/visualizer/base/RoutingTableVisualizerBase.ned b/src/inet/visualizer/base/RoutingTableVisualizerBase.ned
diff --git a/src/inet/visualizer/base/SceneVisualizerBase.ned b/src/inet/visualizer/base/SceneVisualizerBase.ned
diff --git a/src/inet/visualizer/base/StatisticVisualizerBase.ned b/src/inet/visualizer/base/StatisticVisualizerBase.ned
diff --git a/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned b/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned
diff --git a/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned b/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned
diff --git a/src/inet/visualizer/base/VisualizerBase.ned b/src/inet/visualizer/base/VisualizerBase.ned
diff --git a/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned b/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`package inet.clock.base;`
`9`	`9`
`10`	`10`	`//`
`11`		`-// This is a base module for clocks.`
	`11`	`+// Base module for clocks.`
`12`	`12`	`//`
`13`	`13`	`module ClockBase`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ package inet.mobility.static;`
`10`	`10`	`import inet.mobility.base.MobilityBase;`
`11`	`11`
`12`	`12`	`//`
`13`		`-// This mobility module does nothing; it can be used for stationary nodes.`
	`13`	`+// Mobility module for stationary nodes.`
`14`	`14`	`//`
`15`	`15`	`simple StationaryMobility extends MobilityBase`
`16`	`16`	`{`