Skip to content

Commit

Permalink
remove dash after @param
Browse files Browse the repository at this point in the history
  • Loading branch information
bobjacobsen committed Mar 17, 2019
1 parent 1ed51f3 commit 1f67ce7
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion java/src/jmri/BlockManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ public List<Block> getBlocksOccupiedByRosterEntry(@Nonnull RosterEntry re) {
*
* Also listen for additions/removals or PowerManagers
*
* @param e - the change event
* @param e the change event
*/

@Override
Expand Down
6 changes: 3 additions & 3 deletions java/src/jmri/ConditionalManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public interface ConditionalManager extends Manager<Conditional> {
* Parses the Conditional system name to get the parent Logix system name,
* then gets the parent Logix, and returns it.
*
* @param name - system name of Conditional (must be trimmed and upper case)
* @param name system name of Conditional (must be trimmed and upper case)
* @return the logix for the conditional
*/
public Logix getParentLogix(String name);
Expand All @@ -59,8 +59,8 @@ public interface ConditionalManager extends Manager<Conditional> {
* lookup. If this fails, or if x == null, looks up assuming that name is a
* System Name. If both fail, returns null.
*
* @param x - parent Logix (may be null)
* @param name - name to look up
* @param x parent Logix (may be null)
* @param name name to look up
* @return null if no match found
*/
public Conditional getConditional(Logix x, String name);
Expand Down
4 changes: 2 additions & 2 deletions java/src/jmri/Logix.java
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public interface Logix extends NamedBean {
* Add/Edit Logix dialog. If 'order' is greater than the number of
* Conditionals for this Logix, and empty String is returned.
*
* @param order - order in which the Conditional calculates
* @param order order in which the Conditional calculates
* @return system name of conditional or an empty String
*/
public String getConditionalByNumberOrder(int order);
Expand All @@ -90,7 +90,7 @@ public interface Logix extends NamedBean {
* Add a Conditional name and sequence number to this Logix.
*
* @param systemName The Conditional system name
* @param order - the order this conditional should calculate in if
* @param order the order this conditional should calculate in if
* order is negative, the conditional is added at the end
* of current group of conditionals
* @return true if the Conditional was added, false otherwise (most likely
Expand Down
2 changes: 1 addition & 1 deletion java/src/jmri/NamedBean.java
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ public interface NamedBean extends Comparable<NamedBean> {
* Get a list of all the property change listeners that are registered using
* a specific name
*
* @param name - The name (either system or user) that the listener has
* @param name The name (either system or user) that the listener has
* registered as referencing this namedBean
* @return empty list if none
*/
Expand Down
6 changes: 3 additions & 3 deletions java/src/jmri/SensorManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ public interface SensorManager extends ProvidingManager<Sensor> {
* return the next free valid address up to a maximum of 10 addresses away
* from the initial address. Used when adding add a range of Sensors.
*
* @param curAddress - The hardware address of the sensor we wish to add
* @param prefix - The System Prefix used to make up the systemName
* @param curAddress The hardware address of the sensor we wish to add
* @param prefix The System Prefix used to make up the systemName
* check.
* @return - null if the system name made from prefix and curAddress is in
* @return null if the system name made from prefix and curAddress is in
* use
* @throws jmri.JmriException if problem calculating next address
*/
Expand Down
36 changes: 18 additions & 18 deletions java/src/jmri/ThrottleManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -291,29 +291,29 @@ public interface ThrottleManager {

/**
*
* @param la - Loco address to test
* @return - true, its still required, false its not.
* @param la Loco address to test
* @return true, its still required, false its not.
*/
public boolean addressStillRequired(LocoAddress la);

/**
*
* @param address - Loco number to test.
* @param addressIsLong - true if long address.
* @return - true, its still required, false its not.
* @param address Loco number to test.
* @param addressIsLong true if long address.
* @return true, its still required, false its not.
*/
public boolean addressStillRequired(int address, boolean addressIsLong);
/**
*
* @param address - Loco number to test
* @return - true, its still required, false its not.
* @param address Loco number to test
* @return true, its still required, false its not.
*/
public boolean addressStillRequired(int address);

/**
*
* @param re - roster entry to test
* @return - true, its still required, false its not.
* @param re roster entry to test
* @returntrue, its still required, false its not.
*/
public boolean addressStillRequired(BasicRosterEntry re);

Expand Down Expand Up @@ -376,8 +376,8 @@ public interface ThrottleManager {
* The PropertyChangeListener will be notified if it has been attached to a
* loco address or not, via a PropertyChange notification.
* <p>
* @param la - LocoAddress of the loco we wish to monitor
* @param p - PropertyChangeListener to attach to the throttle
* @param la LocoAddress of the loco we wish to monitor
* @param p PropertyChangeListener to attach to the throttle
*/
public void attachListener(LocoAddress la, PropertyChangeListener p);

Expand All @@ -390,8 +390,8 @@ public interface ThrottleManager {
* The PropertyChangeListener will be notified if it has been removed via a
* PropertyChange notification.
*
* @param la - LocoAddress of the loco we wish to monitor
* @param p - PropertyChangeListener to remove from the throttle
* @param la LocoAddress of the loco we wish to monitor
* @param p PropertyChangeListener to remove from the throttle
*/
public void removeListener(LocoAddress la, PropertyChangeListener p);

Expand All @@ -405,32 +405,32 @@ public interface ThrottleManager {
/**
* Get the number of Throttles sharing the throttle for a ddcaddress.
*
* @param la - LocoAddress of the loco you want the throttle usage count for.
* @param la LocoAddress of the loco you want the throttle usage count for.
* @return number of throttles for this address, or 0 if throttle does not exist
*/
public int getThrottleUsageCount(LocoAddress la);

/**
* Get the number of Throttles sharing the throttle for a ddcaddress.
*
* @param address - number of the loco you want the throttle usage count for.
* @param isLongAddress - indicates whether the address is long or not.
* @param address number of the loco you want the throttle usage count for.
* @param isLongAddress indicates whether the address is long or not.
* @return number of throttles for this address, or 0 if throttle does not exist
*/
public int getThrottleUsageCount(int address, boolean isLongAddress);

/**
* Get the number of Throttles sharing the throttle for a ddcaddress.
*
* @param address - number of the loco you want the throttle usage count for.
* @param address number of the loco you want the throttle usage count for.
* @return number of throttles for this address, or 0 if throttle does not exist
*/
public int getThrottleUsageCount(int address);

/**
* Get the number of Throttles sharing the throttle for a ddcaddress.
*
* @param re - BasicRosterEntry of the loco you want the throttle usage count for.
* @param re BasicRosterEntry of the loco you want the throttle usage count for.
* @return number of throttles for this address, or 0 if throttle does not exist
*/
public int getThrottleUsageCount(BasicRosterEntry re);
Expand Down

0 comments on commit 1f67ce7

Please sign in to comment.