Skip to content

Commit

Permalink
src: NED files: Make parameter comments to start with capital letter
Browse files Browse the repository at this point in the history
It looks much better in the generated documentation, and avoids
inconsistency amond comments when some comments contain full sentences.

Using regex case-sensitive find/replace: "(; +// [a-z])" --> "\U$1"
  • Loading branch information
avarga committed May 14, 2024
1 parent 3584bab commit 3d0b394
Show file tree
Hide file tree
Showing 377 changed files with 1,697 additions and 1,697 deletions.
2 changes: 1 addition & 1 deletion src/inet/applications/clock/SimpleClockSynchronizer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ simple SimpleClockSynchronizer like IApp
parameters:
string masterClockModule;
string slaveClockModule;
volatile double synchronizationInterval @unit(s); // clock synchronization period
volatile double synchronizationInterval @unit(s); // Clock synchronization period
volatile double synchronizationClockTimeError @unit(s) = default(0s); // 0 means slave clock time equals master clock time after synchronization
volatile double synchronizationOscillatorCompensationError @unit(ppm) = default(0ppm); // 0 means slave clock speed equals master clock speed after synchronization
@display("i=block/app");
Expand Down
12 changes: 6 additions & 6 deletions src/inet/applications/dhcp/DhcpClient.ned
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ import inet.applications.contract.IApp;
simple DhcpClient like IApp
{
parameters:
string interfaceTableModule; // path to the InterfaceTable module
string routingTableModule; // path to the Ipv4RoutingTable module
string interface = default(""); // which NIC should be configured (i.e. wlan0, eth1 etc.)
double startTime @unit(s) = default(0s); // starting time of DHCP initialization
string interfaceTableModule; // Path to the InterfaceTable module
string routingTableModule; // Path to the Ipv4RoutingTable module
string interface = default(""); // Which NIC should be configured (i.e. wlan0, eth1 etc.)
double startTime @unit(s) = default(0s); // Starting time of DHCP initialization
@display("i=block/app2");
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@selfMessageKinds(inet::DhcpTimerType);
gates:
input socketIn @labels(UdpControlInfo/up);
Expand Down
18 changes: 9 additions & 9 deletions src/inet/applications/dhcp/DhcpServer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ import inet.applications.contract.IApp;
simple DhcpServer like IApp
{
parameters:
string interfaceTableModule; // the path to the InterfaceTable module
string interface = default(""); // interface to listen on; can be left empty if there is only one non-loopback interface
int numReservedAddresses; // number of addresses to skip at the start of the network's address range
int maxNumClients; // maximum number of clients (IPs) allowed to be leased
string gateway = default(""); // gateway to assign, if empty use the interface address
int leaseTime @unit(s); // lease time in seconds
double startTime @unit(s) = default(0s); // application start time
string interfaceTableModule; // The path to the InterfaceTable module
string interface = default(""); // Interface to listen on; can be left empty if there is only one non-loopback interface
int numReservedAddresses; // Number of addresses to skip at the start of the network's address range
int maxNumClients; // Maximum number of clients (IPs) allowed to be leased
string gateway = default(""); // Gateway to assign, if empty use the interface address
int leaseTime @unit(s); // Lease time in seconds
double startTime @unit(s) = default(0s); // Application start time
@display("i=block/app2");
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
gates:
input socketIn @labels(UdpControlInfo/up);
output socketOut @labels(UdpControlInfo/down);
Expand Down
22 changes: 11 additions & 11 deletions src/inet/applications/ethernet/EtherAppClient.ned
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ simple EtherAppClient
{
parameters:
string interfaceTableModule;
string destAddress = default(""); // destination MAC address, or module path name of destination station; empty means off
string interface = default(""); // outgoing interface name; empty accepted only when the destAddress is empty
double startTime @unit(s) = default(this.sendInterval); // time of sending the first request
double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever
int localSAP = default(0xf0); // local service access point
int remoteSAP = default(0xf1); // remote service access point
volatile double sendInterval @unit(s) = default(uniform(0s,1s)); // interval between sending requests
volatile int reqLength @unit(B) = default(100B); // length of request packets
volatile int respLength @unit(B) = default(1KiB); // length of response packets
string destAddress = default(""); // Destination MAC address, or module path name of destination station; empty means off
string interface = default(""); // Outgoing interface name; empty accepted only when the destAddress is empty
double startTime @unit(s) = default(this.sendInterval); // Time of sending the first request
double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever
int localSAP = default(0xf0); // Local service access point
int remoteSAP = default(0xf1); // Remote service access point
volatile double sendInterval @unit(s) = default(uniform(0s,1s)); // Interval between sending requests
volatile int reqLength @unit(B) = default(100B); // Length of request packets
volatile int respLength @unit(B) = default(1KiB); // Length of response packets
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@display("i=block/app");
@signal[packetSent](type=inet::Packet);
@signal[packetReceived](type=inet::Packet);
Expand Down
4 changes: 2 additions & 2 deletions src/inet/applications/ethernet/EtherAppServer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ simple EtherAppServer
parameters:
int localSAP = default(0xf1);
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@display("i=block/app");
@signal[packetSent](type=inet::Packet);
@signal[packetReceived](type=inet::Packet);
Expand Down
22 changes: 11 additions & 11 deletions src/inet/applications/ethernet/EtherTrafGen.ned
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ package inet.applications.ethernet;
simple EtherTrafGen
{
parameters:
string destAddress = default(""); // destination MAC address, or module path name of destination station; empty means off
string interface; // outgoing interface
string destAddress = default(""); // Destination MAC address, or module path name of destination station; empty means off
string interface; // Outgoing interface
string interfaceTableModule;
int ssap = default(-1); // llc ssap to set on outgoing packets
int dsap = default(-1); // llc dsap to set on outgoing packets
double startTime @unit(s) = default(this.sendInterval); // time of sending the first packet
double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever
volatile double sendInterval @unit(s); // interval between sending bursts
volatile int numPacketsPerBurst = default(1); // number of packets to send per burst (packets within a burst are sent at the same simulation time)
volatile int packetLength @unit(B); // length of packets to send
int ssap = default(-1); // Llc ssap to set on outgoing packets
int dsap = default(-1); // Llc dsap to set on outgoing packets
double startTime @unit(s) = default(this.sendInterval); // Time of sending the first packet
double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever
volatile double sendInterval @unit(s); // Interval between sending bursts
volatile int numPacketsPerBurst = default(1); // Number of packets to send per burst (packets within a burst are sent at the same simulation time)
volatile int packetLength @unit(B); // Length of packets to send
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@display("i=block/app");
@signal[packetSent](type=inet::Packet);
@signal[packetReceived](type=inet::Packet);
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/ethernet/EthernetApp.ned
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import inet.queueing.contract.IPassivePacketSink;
module EthernetApp like IApp
{
parameters:
string interfaceTableModule; // relative module path of the interface table
string interfaceTableModule; // Relative module path of the interface table
*.interfaceTableModule = default(absPath(this.interfaceTableModule));
@application;
@display("i=block/app");
Expand Down
16 changes: 8 additions & 8 deletions src/inet/applications/ethernet/EthernetSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ package inet.applications.ethernet;
simple EthernetSocketIo
{
parameters:
string interfaceTableModule; // relative module path of the interface table
string interface = default(""); // network interface name
string protocol = default(""); // bind the socket to this protocol if specified
string localAddress = default(""); // local Ethernet MAC address
string remoteAddress = default(""); // remove Ethernet MAC address
bool steal = default(false); // steal packets
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
string interfaceTableModule; // Relative module path of the interface table
string interface = default(""); // Network interface name
string protocol = default(""); // Bind the socket to this protocol if specified
string localAddress = default(""); // Local Ethernet MAC address
string remoteAddress = default(""); // Remove Ethernet MAC address
bool steal = default(false); // Steal packets
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@lifecycleSupport();
@display("i=block/socket");
@signal[packetSent](type=inet::Packet);
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/external/ExternalApp.ned
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import inet.common.ExternalProcess;
module ExternalApp like IApp
{
parameters:
string namespace = default(""); // name of the host OS network namespace (optional)
string namespace = default(""); // Name of the host OS network namespace (optional)
*.namespace = default(this.namespace);
@display("i=block/app");
gates:
Expand Down
14 changes: 7 additions & 7 deletions src/inet/applications/generic/IpvxTrafGen.ned
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ package inet.applications.generic;
simple IpvxTrafGen like IIpvxTrafficGenerator
{
parameters:
double startTime @unit(s) = default(1s); // time of sending the first packet
double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever
volatile double sendInterval @unit(s) = default(10ms); // may be a random value, e.g. exponential(1)
int numPackets = default(-1); // max number of packets to generate, -1 means forever
int protocol; // value for IPv4, IPv6 protocol field, accepts only between 143 and 254
volatile int packetLength @unit(B); // packet length in bytes
string destAddresses = default(""); // list of destination addresses, separated by spaces
double startTime @unit(s) = default(1s); // Time of sending the first packet
double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever
volatile double sendInterval @unit(s) = default(10ms); // May be a random value, e.g. exponential(1)
int numPackets = default(-1); // Max number of packets to generate, -1 means forever
int protocol; // Value for IPv4, IPv6 protocol field, accepts only between 143 and 254
volatile int packetLength @unit(B); // Packet length in bytes
string destAddresses = default(""); // List of destination addresses, separated by spaces
@lifecycleSupport;
@display("i=block/source");
@signal[packetSent](type=inet::Packet);
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/generic/IpvxTrafSink.ned
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ package inet.applications.generic;
simple IpvxTrafSink like IIpvxTrafficGenerator
{
parameters:
int protocol; // value for IPv4, IPv6 protocol field, accepts only between 143 and 254
int protocol; // Value for IPv4, IPv6 protocol field, accepts only between 143 and 254
@lifecycleSupport;
@display("i=block/sink");
@signal[packetReceived](type=inet::Packet);
Expand Down
4 changes: 2 additions & 2 deletions src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ simple Ieee8022LlcSocketIo
string remoteAddress = default("");
int localSap = default(-1);
int remoteSap = default(-1);
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@lifecycleSupport();
@display("i=block/socket");
@signal[packetSent](type=inet::Packet);
Expand Down
4 changes: 2 additions & 2 deletions src/inet/applications/ipapp/IpSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ simple IpSocketIo
string localAddress = default("");
string destAddress = default("");
string protocol = default("");
double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@lifecycleSupport();
@display("i=block/socket");
@signal[packetSent](type=inet::Packet);
Expand Down
10 changes: 5 additions & 5 deletions src/inet/applications/netperfmeter/NetPerfMeter.ned
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ simple NetPerfMeter like IApp
{
parameters:
bool activeMode = default(true); // Server (false) or client (true)
string localAddress = default(""); // may be left empty ("")
int localPort = default(9000); // port number to listen on
string remoteAddress = default(""); // server address (may be symbolic)
int remotePort = default(9000); // port number to connect to
string localAddress = default(""); // May be left empty ("")
int localPort = default(9000); // Port number to listen on
string remoteAddress = default(""); // Server address (may be symbolic)
int remotePort = default(9000); // Port number to connect to

double connectTime @unit(s) = default(0s); // Absolute time to establish connection
double startTime @unit(s) = default(1s); // Transmission start, relative to "connectTime"
Expand All @@ -59,7 +59,7 @@ simple NetPerfMeter like IApp
int outboundStreams = default(1); // Number of outbound streams (SCTP only)
int maxInboundStreams = default(16); // Maximum number of inbound streams (SCTP only)
string protocol = default("SCTP"); // Transport protocol to use
string primaryPath = default(""); // primary path (may be symbolic; SCTP only)
string primaryPath = default(""); // Primary path (may be symbolic; SCTP only)

volatile double frameRate @unit(Hz) = default(1 Hz); // Outgoing frame rate
volatile int frameSize @unit(B) = default(1452 B); // Outgoing frame size
Expand Down
Loading

0 comments on commit 3d0b394

Please sign in to comment.