Skip to content

Commit 6e4dd8e

Browse files
committed
neddoc: wording: get rid of the "This module..." mannerism
1 parent 50d29a0 commit 6e4dd8e

109 files changed

Lines changed: 135 additions & 142 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/simu5g/apps/alert/AlertReceiver.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.alert;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module receives alert messages sent by nodes running an ~AlertSender
17+
// Receives alert messages sent by nodes running an ~AlertSender
1818
// application. It listens for incoming packets and logs their arrival.
1919
// It records end-to-end delay statistics. The module also supports multicast by
2020
// joining local multicast groups.

src/simu5g/apps/alert/AlertSender.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.alert;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module generates periodic alert messages and sends them to a specified multicast
17+
// Generates periodic alert messages and sends them to a specified multicast
1818
// group or unicast destination. The packet size, transmission period, start time, and stop
1919
// time are configurable using the corresponding parameters. The destination address must be a
2020
// multicast IP address. This module can be used in simulations that require periodic alert

src/simu5g/apps/burst/BurstReceiver.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.burst;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module models an application that receives bursts of packets from
17+
// Models an application that receives bursts of packets from
1818
// a ~BurstSender application module. It binds to a specified UDP local port,
1919
// logs the received packets, and records statistics such as packet delay.
2020
//

src/simu5g/apps/burst/BurstSender.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.burst;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module models an application that sends bursts of packets to a ~BurstReceiver
17+
// Models an application that sends bursts of packets to a ~BurstReceiver
1818
// application. During each burst, the application sends a configurable number of
1919
// packets at regular intervals. The time interval between bursts can also be configured.
2020
//

src/simu5g/apps/cbr/CbrReceiver.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.cbr;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module receives Constant Bit Rate (CBR) traffic sent by a ~CbrSender
17+
// Receives Constant Bit Rate (CBR) traffic sent by a ~CbrSender
1818
// application module. It binds to a specified local port and records
1919
// statistics such as packet delay, jitter, packet loss, throughput, and the
2020
// total amount of bytes received.

src/simu5g/apps/d2dMultihop/MultihopD2D.ned

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ package simu5g.apps.d2dMultihop;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module implements an application for disseminating event notifications,
18-
// using multihop D2D transmissions. New messages are generated upon the reception
17+
// Disseminates event notifications using multihop D2D transmissions.
18+
// New messages are generated upon the reception
1919
// of external events, signaled by the ~EventGenerator module. The application
2020
// sends the message to an IP multicast address, which is then mapped to D2D
2121
// multicast transmission mode within the LTE/NR protocol stack. When the application

src/simu5g/apps/d2dMultihop/eventGenerator/EventGenerator.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
package simu5g.apps.d2dMultihop.eventGenerator;
1313

1414
//
15-
// This module is only used in conjunction with UEs running
15+
// Only used in conjunction with UEs running
1616
// a ~MultihopD2D application instance. It generates periodic
1717
// "events" (e.g., a collision between vehicles) at random
1818
// positions within the network (or by randomly selecting a node)

src/simu5g/apps/d2dMultihop/statistics/MultihopD2DStatistics.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
package simu5g.apps.d2dMultihop.statistics;
1212

1313
//
14-
// This module is only used in conjunction with UEs running instances of the
14+
// Only used in conjunction with UEs running instances of the
1515
// ~MultihopD2D application. It collects statistics related to notification messages
1616
// broadcast by the ~MultihopD2D applications by gathering data through method
1717
// calls from these applications.

src/simu5g/apps/mec/DeviceApp/DeviceApp.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.mec.DeviceApp;
1414
import inet.applications.contract.IApp;
1515

1616
//
17-
// This module models the Device App entity as defined by the ETSI Multi-access Edge Computing (MEC)
17+
// Models the Device App entity as defined by the ETSI Multi-access Edge Computing (MEC)
1818
// specifications. The Device App can be instantiated on a User Equipment (UE) that wants to
1919
// dynamically instantiate a MEC application within a MEC system. It establishes a TCP connection
2020
// with the User App Lifecycle Management Proxy (UALCMP) entity (see the ~Ualcmp module) and, upon

src/simu5g/apps/mec/MecApps/MecRequestBackgroundApp/MecRequestBackgroundApp.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ package simu5g.apps.mec.MecApps.MecRequestBackgroundApp;
1414
import simu5g.apps.mec.MecApps.MecAppBase;
1515

1616
//
17-
// This module implements a generator of requests to be sent to the ~LocationService.
17+
// Generates requests to be sent to the ~LocationService.
1818
// This application can be instantiated as an "independent MEC app" (see ~MecHost
1919
// module), which means it does not need to be instantiated via the MEC orchestrator upon
2020
// request from a User Equipment. In particular, this module produces bulks of

0 commit comments

Comments
 (0)