Skip to content

Commit

Permalink
src: proofread NED file parameter comments using LLM
Browse files Browse the repository at this point in the history
  • Loading branch information
avarga committed May 14, 2024
1 parent 3d0b394 commit e093ad9
Show file tree
Hide file tree
Showing 192 changed files with 458 additions and 484 deletions.
2 changes: 1 addition & 1 deletion src/inet/applications/ethernet/EtherAppServer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ simple EtherAppServer
parameters:
int localSAP = default(0xf1);
@lifecycleSupport;
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished
double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation is finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@display("i=block/app");
@signal[packetSent](type=inet::Packet);
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/ethernet/EthernetSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ simple EthernetSocketIo
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
string remoteAddress = default(""); // Remote 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
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 values between 143 and 254
@lifecycleSupport;
@display("i=block/sink");
@signal[packetReceived](type=inet::Packet);
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ 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 stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finishes
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@lifecycleSupport();
@display("i=block/socket");
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/ipapp/IpSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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 stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finishes
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation
@lifecycleSupport();
@display("i=block/socket");
Expand Down
14 changes: 7 additions & 7 deletions src/inet/applications/pingapp/PingApp.ned
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,23 @@ import inet.applications.contract.IApp;
simple PingApp like IApp
{
parameters:
string destAddr = default(""); // Destination address(es), separated by spaces, "*" means all IPv4/IPv6 interfaces in entire simulation
string destAddr = default(""); // Destination address(es), separated by spaces, "*" means all IPv4/IPv6 interfaces in the entire simulation
string srcAddr = default(""); // Source address (useful with multi-homing)
int packetSize @unit(B) = default(56B); // Of ping payload, in bytes
int packetSize @unit(B) = default(56B); // Size of ping payload, in bytes
volatile double sendInterval @unit(s) = default(1s); // Time to wait between pings (can be random)
int hopLimit = default(-1); // TTL or hopLimit for IP packets
int count = default(-1); // Number of pings requests sent to a single destination address, -1 means continuously (only first address will be used from destAddr)
double startTime @unit(s) = default(uniform(0s, this.sleepDuration + this.sendInterval)); // Send first ping at startTime
int count = default(-1); // Number of ping requests sent to a single destination address, -1 means continuously (only first address will be used from destAddr)
double startTime @unit(s) = default(uniform(0s, this.sleepDuration + this.sendInterval)); // Send the first ping at startTime
double stopTime @unit(s) = default(-1s); // Time to finish sending, negative values mean forever
volatile double sleepDuration @unit(s) = default(0s); // Time spent in sleep between switching destinations
bool continuous = default(false); // Whether to continuously ping the destinations in a round-robin fashion
bool printPing = default(false); // Log to stdout
string crcMode @enum("declared", "computed") = default("declared");
string networkProtocol = default(""); // Uses specified network protocol for communication; uses the address-specified default network protocol when the parameter is empty
string networkProtocol = default(""); // Uses the specified network protocol for communication; uses the address-specified default network protocol when the parameter is empty
@display("i=block/app");
@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 the lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation
@signal[rtt](type=simtime_t);
@signal[numLost](type=long);
@signal[numOutOfOrderArrivals](type=long);
Expand Down
10 changes: 5 additions & 5 deletions src/inet/applications/rtpapp/RtpApplication.ned
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ simple RtpApplication
double bandwidth; // Bandwidth in bytes per second for this session
string destinationAddress; // Destination address (the L3AddressResolver 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
string fileName; // Filename of file to be transmitted, "" means this system acts only as a receiver
int payloadType; // Payload type of file to transmit
double sessionEnterDelay @unit(s); // Delay before starts a new session
double transmissionStartDelay @unit(s); // Delay before start transmission (related to "sender module created")
double transmissionStopDelay @unit(s); // Delay before stops transmission (related to "start transmission")
double sessionLeaveDelay @unit(s); // Delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
double sessionEnterDelay @unit(s); // Delay before starting a new session
double transmissionStartDelay @unit(s); // Delay before starting transmission (related to "sender module created")
double transmissionStopDelay @unit(s); // Delay before stopping transmission (related to "start transmission")
double sessionLeaveDelay @unit(s); // Delay before leaving session (related to "file transmission finished/stopped" or "session entered" when fileName is "")
@selfMessageKinds(inet::RtpAppSelfMsgKinds); // Kind used in self messages

gates:
Expand Down
14 changes: 7 additions & 7 deletions src/inet/applications/sctpapp/SctpClient.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@ import inet.applications.contract.IApp;
simple SctpClient like IApp
{
parameters:
string localAddress = default(""); // Comma separated list of addresses
string localAddress = default(""); // Comma-separated list of addresses
int localPort = default(0); // Port number to listen on
string connectAddress; // Server address (may be symbolic)
int connectPort; // Port number to connect to
double startTime @unit(s) = default(1s); // Time first session begins
double startTime @unit(s) = default(1s); // Time the first session begins
volatile int numRequestsPerSession = default(1); // Number of requests sent per session
int numPacketsToReceive = default(0);
int requestLength = default(1452); // Length of a request (bytes)
double thinkTime @unit(s) = default(0s); // Time gap between requests
double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort
double reconnectInterval @unit(s) = default(0s); // If connection breaks, waits this much before trying to reconnect
double waitToClose @unit(s) = default(0s); // Time to wait between the last message sent and abort
double reconnectInterval @unit(s) = default(0s); // If the connection breaks, waits this much before trying to reconnect
int inboundStreams = default(17);
int outboundStreams = default(1);
bool echo = default(false); // Echoes received packages when true
bool ordered = default(true);
int queueSize = default(0);
int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); //for PR-SCTP
int prMethod = default(0); // 0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); // For PR-SCTP
bool streamReset = default(false);
double streamRequestTime @unit(s) = default(0s);
int streamResetType = default(5); //NO_RESET=5, RESET_OUTGOING=6, RESET_INCOMING=7, RESET_BOTH=8, SSN_TSN=9
int streamResetType = default(5); // NO_RESET=5, RESET_OUTGOING=6, RESET_INCOMING=7, RESET_BOTH=8, SSN_TSN=9
int streamToReset = default(0);
double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever
double primaryTime @unit(s) = default(0s);
Expand Down
6 changes: 3 additions & 3 deletions src/inet/applications/sctpapp/SctpNatPeer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import inet.applications.contract.IApp;
simple SctpNatPeer like IApp
{
parameters:
string localAddress = default(""); // Comma separated list of addresses
string localAddress = default(""); // Comma-separated list of addresses
int localPort = default(0); // Port number to listen on
string connectAddress; // Server address (may be symbolic)
int connectPort; // Port number to connect to
Expand All @@ -21,8 +21,8 @@ simple SctpNatPeer like IApp
int numPacketsToReceive = default(0);
int requestLength = default(1452); // Length of a request (bytes)
double thinkTime @unit(s) = default(0s); // Time gap between requests
double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort
//# double reconnectInterval @unit(s) = default(0); // If connection breaks, waits this much before trying to reconnect
double waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort
//# double reconnectInterval @unit(s) = default(0); // If the connection breaks, wait this much before trying to reconnect
int outboundStreams = default(1);
int inboundStreams = default(1);
bool echo = default(false); // Echoes received packages when true
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/sctpapp/SctpNatServer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ simple SctpNatServer like IApp
int numPacketsToSendPerClient = default(0); // Number of requests sent per session
int numPacketsToReceivePerClient = default(1);
int requestLength = default(1452); // Length of a request (bytes)
double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort
double waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort
int outboundStreams = default(1);
int inboundStreams = default(1);
bool ordered = default(true);
Expand Down
10 changes: 5 additions & 5 deletions src/inet/applications/sctpapp/SctpPeer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import inet.applications.contract.IApp;
simple SctpPeer like IApp
{
parameters:
string localAddress = default(""); // Comma separated list of addresses
string localAddress = default(""); // Comma-separated list of addresses
int localPort = default(0); // Port number to listen on
bool echo = default(false); // Echoes received packages when true
double echoDelay @unit(s) = default(0s);
Expand All @@ -21,17 +21,17 @@ simple SctpPeer like IApp
int numPacketsToReceivePerClient = default(1);
int requestLength = default(1452); // Length of a request (bytes)
double thinkTime @unit(s) = default(0s); // Time gap between requests
double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort
double waitToClose @unit(s) = default(0s); // Time to wait between the last message sent and abort
bool ordered = default(true);
int outboundStreams = default(1);
int inboundStreams = default(17);
int queueSize = default(0);
int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); //for PR-SCTP
int prMethod = default(0); // 0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); // For PR-SCTP
bool streamReset = default(false);
string connectAddress; // Server address (may be symbolic)
int connectPort; // Port number to connect to
double startTime @unit(s) = default(1s); // Time first session begins
double startTime @unit(s) = default(1s); // Time the first session begins
int numRequestsPerSession = default(1); // Number of requests sent per session
int numPacketsToReceive = default(0);
string streamPriorities = default("");
Expand Down
8 changes: 4 additions & 4 deletions src/inet/applications/sctpapp/SctpServer.ned
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import inet.applications.contract.IApp;
simple SctpServer like IApp
{
parameters:
string localAddress = default(""); // Comma separated list of addresses
string localAddress = default(""); // Comma-separated list of addresses
int localPort = default(0); // Port number to listen on
bool echo = default(false); // Echoes received packages when true
volatile double echoDelay @unit(s) = default(0s);
Expand All @@ -28,14 +28,14 @@ simple SctpServer like IApp
int numPacketsToReceivePerClient = default(1);
int requestLength = default(1452); // Length of a request (bytes)
volatile double thinkTime @unit(s) = default(0s); // Time gap between requests
double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort
double waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort
bool finishEndsSimulation = default(false);
bool ordered = default(true);
int inboundStreams = default(17);
int outboundStreams = default(1);
int queueSize = default(0);
int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); //for PR-SCTP
int prMethod = default(0); // 0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST
double prValue = default(0); // For PR-SCTP
bool streamReset = default(false);
double streamRequestTime @unit(s) = default(0s);
int streamToReset = default(0);
Expand Down
10 changes: 5 additions & 5 deletions src/inet/applications/tcpapp/TcpBasicClientApp.ned
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,22 @@ simple TcpBasicClientApp like IApp
int connectPort = default(1000); // Port number to connect to
bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection
volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay
double startTime @unit(s) = default(1s); // Time first session begins
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the previous READ was satisfied; -1 means immediately, 0 means zero delay
double startTime @unit(s) = default(1s); // Time the first session begins
double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever
volatile int numRequestsPerSession = default(1); // Number of requests sent per session
volatile int requestLength @unit(B) = default(200B); // Length of a request
volatile int replyLength @unit(B) = default(1MiB); // Length of a reply
volatile double thinkTime @unit(s); // Time gap between requests
volatile double idleInterval @unit(s); // Time gap between sessions
volatile double reconnectInterval @unit(s) = default(30s); // If connection breaks, waits this much before trying to reconnect
volatile double reconnectInterval @unit(s) = default(30s); // If the connection breaks, wait this long before trying to reconnect
int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value
int dscp = default(-1); // If not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value
int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value
@display("i=block/app");
@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 the lifecycle stop operation finished
double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation
@signal[packetSent](type=inet::Packet);
@signal[packetReceived](type=inet::Packet);
@signal[connect](type=long); // 1 for open, -1 for close
Expand Down
2 changes: 1 addition & 1 deletion src/inet/applications/tcpapp/TcpClientSocketIo.ned
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ simple TcpClientSocketIo
int connectPort;
bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection
volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the previous READ was satisfied; -1 means immediately, 0 means zero delay
@display("i=block/socket");
gates:
input trafficIn;
Expand Down
4 changes: 2 additions & 2 deletions src/inet/applications/tcpapp/TcpEchoApp.ned
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ simple TcpEchoApp extends TcpServerHostApp
@class(TcpEchoApp);
bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection
volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay
volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the previous READ was satisfied; -1 means immediately, 0 means zero delay
double echoFactor = default(1);
double echoDelay @unit(s) = default(0s);
serverThreadModuleType = default("inet.applications.tcpapp.TcpEchoAppThread"); // Module type of "thread" module to launch on incoming connections
serverThreadModuleType = default("inet.applications.tcpapp.TcpEchoAppThread"); // Module type of the "thread" module to launch on incoming connections
@signal[packetSent](type=inet::Packet);
@signal[packetReceived](type=inet::Packet);
@statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none);
Expand Down
Loading

0 comments on commit e093ad9

Please sign in to comment.