Skip to content

Commit

Permalink
Normalize Javadoc @param formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jun 16, 2024
1 parent bbb0a2c commit 89bfae7
Show file tree
Hide file tree
Showing 17 changed files with 118 additions and 118 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ public static void main(final String[] args) throws Exception {
/**
* Callback method called when TelnetClient receives an option negotiation command.
*
* @param negotiation_code - type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
* @param option_code - code of the option negotiated
* @param negotiation_code type of negotiation command received (RECEIVED_DO, RECEIVED_DONT, RECEIVED_WILL, RECEIVED_WONT, RECEIVED_COMMAND)
* @param option_code code of the option negotiated
*/
@Override
public void receivedNegotiation(final int negotiation_code, final int option_code) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public interface FTPTimestampParser {
/**
* Parses the supplied datestamp parameter. This parameter typically would have been pulled from a longer FTP listing via the regular expression mechanism
*
* @param timestampStr - the timestamp portion of the FTP directory listing to be parsed
* @param timestampStr the timestamp portion of the FTP directory listing to be parsed
* @return a <code>java.util.Calendar</code> object initialized to the date parsed by the parser
* @throws ParseException if none of the parser mechanisms belonging to the implementor can parse the input.
*/
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/net/ntp/NtpV3Packet.java
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ public interface NtpV3Packet {
/**
* Sets leap indicator.
*
* @param li - leap indicator code
* @param li leap indicator code
*/
void setLeapIndicator(int li);

Expand All @@ -252,7 +252,7 @@ public interface NtpV3Packet {
/**
* Sets originate timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
* @param ts timestamp
*/
void setOriginateTimeStamp(TimeStamp ts);

Expand All @@ -274,7 +274,7 @@ public interface NtpV3Packet {
/**
* Sets receive timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
* @param ts timestamp
*/
void setReceiveTimeStamp(TimeStamp ts);

Expand All @@ -288,7 +288,7 @@ public interface NtpV3Packet {
/**
* Sets the reference timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
* @param ts timestamp
*/
void setReferenceTime(TimeStamp ts);

Expand Down Expand Up @@ -317,7 +317,7 @@ public interface NtpV3Packet {
/**
* Sets the {@code transmit} timestamp given NTP TimeStamp object.
*
* @param ts - timestamp
* @param ts timestamp
*/
void setTransmitTime(TimeStamp ts);

Expand Down
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/net/ntp/TimeStamp.java
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ public class TimeStamp implements Serializable, Comparable<TimeStamp> {
/**
* Left-pad 8-character hexadecimal string with 0's
*
* @param buf - StringBuilder which is appended with leading 0's.
* @param l - a long.
* @param buf StringBuilder which is appended with leading 0's.
* @param l a long.
*/
private static void appendHexString(final StringBuilder buf, final long l) {
final String s = Long.toHexString(l);
Expand Down Expand Up @@ -157,7 +157,7 @@ public static long getTime(final long ntpTimeValue) {
/**
* Parses the string argument as a NTP hexidecimal timestamp representation string (e.g. "c1a089bd.fc904f6d").
*
* @param s - hexstring.
* @param s hexstring.
* @return the Timestamp represented by the argument in hexidecimal.
* @throws NumberFormatException - if the string does not contain a parsable timestamp.
*/
Expand Down Expand Up @@ -224,7 +224,7 @@ public static String toString(final long ntpTime) {
/**
* Constructs a newly allocated NTP timestamp object that represents the Java Date argument.
*
* @param d - the Date to be represented by the Timestamp object.
* @param d the Date to be represented by the Timestamp object.
*/
public TimeStamp(final Date d) {
ntpTime = d == null ? 0 : toNtpTime(d.getTime());
Expand Down Expand Up @@ -253,7 +253,7 @@ public TimeStamp(final String hexStamp) throws NumberFormatException {
/**
* Compares two Timestamps numerically.
*
* @param anotherTimeStamp - the <code>TimeStamp</code> to be compared.
* @param anotherTimeStamp the <code>TimeStamp</code> to be compared.
* @return the value <code>0</code> if the argument TimeStamp is equal to this TimeStamp; a value less than <code>0</code> if this TimeStamp is numerically
* less than the TimeStamp argument; and a value greater than <code>0</code> if this TimeStamp is numerically greater than the TimeStamp argument
* (signed comparison).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ public EchoOptionHandler() {
* Constructor for the EchoOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
* @param initlocal - if set to true, a WILL is sent upon connection.
* @param initremote - if set to true, a DO is sent upon connection.
* @param acceptlocal - if set to true, any DO request is accepted.
* @param acceptremote - if set to true, any WILL request is accepted.
* @param initlocal if set to true, a WILL is sent upon connection.
* @param initremote if set to true, a DO is sent upon connection.
* @param acceptlocal if set to true, any DO request is accepted.
* @param acceptremote if set to true, any WILL request is accepted.
*/
public EchoOptionHandler(final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(TelnetOption.ECHO, initlocal, initremote, acceptlocal, acceptremote);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ public class InvalidTelnetOptionException extends Exception {
/**
* Constructor for the exception.
*
* @param message - Error message.
* @param optcode - Option code.
* @param message Error message.
* @param optcode Option code.
*/
public InvalidTelnetOptionException(final String message, final int optcode) {
optionCode = optcode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class SimpleOptionHandler extends TelnetOptionHandler {
/**
* Constructor for the SimpleOptionHandler. Initial and accept behavior flags are set to false
*
* @param optcode - option code.
* @param optcode option code.
*/
public SimpleOptionHandler(final int optcode) {
super(optcode, false, false, false, false);
Expand All @@ -34,11 +34,11 @@ public SimpleOptionHandler(final int optcode) {
* Constructor for the SimpleOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
* @param optcode - option code.
* @param initlocal - if set to true, a WILL is sent upon connection.
* @param initremote - if set to true, a DO is sent upon connection.
* @param acceptlocal - if set to true, any DO request is accepted.
* @param acceptremote - if set to true, any WILL request is accepted.
* @param optcode option code.
* @param initlocal if set to true, a WILL is sent upon connection.
* @param initremote if set to true, a DO is sent upon connection.
* @param acceptlocal if set to true, any DO request is accepted.
* @param acceptremote if set to true, any WILL request is accepted.
*/
public SimpleOptionHandler(final int optcode, final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(optcode, initlocal, initremote, acceptlocal, acceptremote);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ public SuppressGAOptionHandler() {
* Constructor for the SuppressGAOptionHandler. Allows defining desired initial setting for local/remote activation of this option and behavior in case a
* local/remote activation request for this option is received.
*
* @param initlocal - if set to true, a WILL is sent upon connection.
* @param initremote - if set to true, a DO is sent upon connection.
* @param acceptlocal - if set to true, any DO request is accepted.
* @param acceptremote - if set to true, any WILL request is accepted.
* @param initlocal if set to true, a WILL is sent upon connection.
* @param initremote if set to true, a DO is sent upon connection.
* @param acceptlocal if set to true, any DO request is accepted.
* @param acceptremote if set to true, any WILL request is accepted.
*/
public SuppressGAOptionHandler(final boolean initlocal, final boolean initremote, final boolean acceptlocal, final boolean acceptremote) {
super(TelnetOption.SUPPRESS_GO_AHEAD, initlocal, initremote, acceptlocal, acceptremote);
Expand Down
Loading

0 comments on commit 89bfae7

Please sign in to comment.