javadoc lint grapevine

java/src/jmri/jmrix/grapevine/GrapevineSystemConnectionMemo.java

@@ -54,6 +54,7 @@ public void setTrafficController(SerialTrafficController tc){
 
     /**
      * Get the traffic controller instance associated with this connection memo.
+     * @return traffic controller, one is provided if null.
      */
     public SerialTrafficController getTrafficController(){
         if (tc == null) {
@@ -97,6 +98,7 @@ public void configureManagers() {
      * Provide access to the SensorManager for this particular connection.
      * <p>
      * NOTE: SensorManager defaults to NULL
+     * @return sensor manager.
      */
     public SensorManager getSensorManager() {
         log.debug(sensorManager != null ? "getSensorManager OK": "getSensorManager returned NULL");
@@ -114,6 +116,7 @@ public void setSensorManager(SerialSensorManager s) {
      * Provide access to the TurnoutManager for this particular connection.
      * <p>
      * NOTE: TurnoutManager defaults to NULL
+     * @return turnout manager.
      */
     public TurnoutManager getTurnoutManager() {
         log.debug(turnoutManager != null ? "getTurnoutManager OK": "getTurnoutManager returned NULL");
@@ -131,6 +134,7 @@ public void setTurnoutManager(SerialTurnoutManager t) {
      * Provide access to the LightManager for this particular connection.
      * <p>
      * NOTE: LightManager defaults to NULL
+     * @return light manager.
      */
     public LightManager getLightManager() {
         log.debug(lightManager != null ? "getLightManager OK": "getLightManager returned NULL");

java/src/jmri/jmrix/grapevine/SerialAddress.java

@@ -197,6 +197,8 @@ static int typeOffset(String type) {
     /**
      * Public static method to parse a system name and return the Serial Node.
      *
+     * @param systemName system name.
+     * @param tc system connection traffic controller.
      * @return 'NULL' if illegal systemName format or if the node is not found
      */
     public static SerialNode getNodeFromSystemName(String systemName, SerialTrafficController tc) {
@@ -229,6 +231,8 @@ public static SerialNode getNodeFromSystemName(String systemName, SerialTrafficC
      * Public static method to parse a system name and return the bit number.
      * Notes: Bits are numbered from 1.
      *
+     * @param systemName system name.
+     * @param prefix unused.
      * @return 0 if an error is found
      */
     public static int getBitFromSystemName(String systemName, String prefix) {
@@ -263,6 +267,8 @@ public static int getBitFromSystemName(String systemName, String prefix) {
      * <p>
      * Note: Nodes are numbered from 1.
      *
+     * @param systemName system name.
+     * @param prefix unused.
      * @return node number. If an error is found, returns -1
      */
     public static int getNodeAddressFromSystemName(String systemName, String prefix) {
@@ -532,8 +538,12 @@ public static NameValidity validSystemNameFormat(@Nonnull String systemName, cha
     /**
      * Public static method to validate system name for configuration.
      *
-     * @return 'true' if system name has a valid meaning in current configuration, else
-     * returns 'false'
+     * @param systemName system name to validate.
+     * @param type bean type, S, T or L.
+     * @param tc system connection traffic controller.
+     * @return 'true' if system name has a valid meaning in current configuration, 
+     *                else returns 'false'.
+     * 
      */
     public static boolean validSystemNameConfig(String systemName, char type, SerialTrafficController tc) {
         String prefix = tc.getSystemConnectionMemo().getSystemPrefix();
@@ -573,9 +583,14 @@ public static boolean validSystemNameConfig(String systemName, char type, Serial
 
     /**
      * Public static method to convert any format system name for the alternate
-     * format (nnBnn). If the supplied system name does not have a valid format,
-     * or if there is no representation in the alternate naming scheme, an empty
-     * string is returned.
+     * format (nnBnn).
+     * <p>
+     * If the supplied system name does not have a valid format,
+     * or if there is no representation in the alternate naming scheme,
+     * an empty string is returned.
+     * @param systemName system name to convert.
+     * @param prefix system prefix.
+     * @return alternate string.
      */
     public static String convertSystemNameToAlternate(String systemName, String prefix) {
         // ensure that input system name has a valid format
@@ -606,6 +621,9 @@ public static String convertSystemNameToAlternate(String systemName, String pref
      * If the supplied system name does not have a valid format, an empty string
      * is returned. Otherwise a normalized name is returned in the same format
      * as the input name.
+     * @param systemName system name to normalize.
+     * @param prefix system prefix.
+     * @return normalized string.
      */
     public static String normalizeSystemName(String systemName, String prefix) {
         // ensure that input system name has a valid format

java/src/jmri/jmrix/grapevine/SerialMessage.java

@@ -81,8 +81,10 @@ public int getAddr() {
 
     /**
      * For Grapevine, which doesn't have a data poll, the poll operation is only
-     * used to see that the nodes are present. This is done by sending a "get
-     * software version" command.
+     * used to see that the nodes are present.
+     * This is done by sending a "get software version" command.
+     * @param addr address to poll.
+     * @return serial message to poll data.
      */
     static public SerialMessage getPoll(int addr) {
         // eventually this will have to include logic for reading 
@@ -138,6 +140,7 @@ public void setParity(int start) {
      * Set the number of characters expected back from the command station.
      * Normally four, this is used to set other lengths for special cases, like
      * a reply to a poll (software version) message.
+     * @param len reply length.
      */
     public void setReplyLen(int len) {
         replyLen = len;
@@ -149,6 +152,7 @@ public int getReplyLen() {
 
     /**
      * Format the reply as human-readable text.
+     * @return human-readable text of reply.
      */
     public String format() {
         if (getNumDataElements() == 8) {

java/src/jmri/jmrix/grapevine/SerialNode.java

@@ -74,6 +74,7 @@ static public String[] getBoardNames() {
      * Assumes a node address of 1, and a node type of 0 (NODE2002V6).
      * If this constructor is used, actual node address must be set using
      * 'setNodeAddress()', and actual node type using 'setNodeType()'
+     * @param tc system connection traffic controller.
      */
     public SerialNode(SerialTrafficController tc) {
         this(1, tc);
@@ -172,13 +173,15 @@ public void resetMustSend() {
 
     /**
      * Get node type.
+     * @return node type, e.g. NODE2002V1 or NODE2002V6.
      */
     public int getNodeType() {
         return (nodeType);
     }
 
     /**
      * Set node type.
+     * @param type node type, e.g. NODE2002V1 or NODE2002V6.
      */
     @SuppressWarnings("fallthrough")
     @SuppressFBWarnings(value = "SF_SWITCH_FALLTHROUGH")

java/src/jmri/jmrix/grapevine/SerialReply.java

@@ -42,6 +42,7 @@ public SerialReply(String s) {
 
     /**
      * Is reply to poll message.
+     * @return true if reply to a poll message, else false.
      */
     public int getAddr() {
         return getElement(0) & 0x7F;
@@ -109,6 +110,7 @@ public void setNumDataElements(int len) {
      * <p>
      * Since Grapevine doesn't distinguish between message and reply, this uses
      * the Message method.
+     * @return human readable text of reply.
      */
     @SuppressWarnings("fallthrough")
     @SuppressFBWarnings(value = "SF_SWITCH_FALLTHROUGH")

java/src/jmri/jmrix/grapevine/SerialSensorManager.java

@@ -167,6 +167,7 @@ public void reply(SerialReply r) {
 
     /**
      * Register any orphan Sensors when a new Serial Node is created.
+     * @param node node to register sensors for.
      */
     @SuppressWarnings("deprecation") // needs careful unwinding for Set operations
     public void registerSensorsForNode(SerialNode node) {

java/src/jmri/jmrix/grapevine/SerialTrafficController.java

@@ -54,6 +54,7 @@ public SerialTrafficController(GrapevineSystemConnectionMemo adaptermemo) {
 
     /**
      * Get minimum address of an Grapevine node as set on this TrafficController.
+     * @return minimum node address.
      */
     public int getMinimumNodeAddress() {
         return minNode;
@@ -88,6 +89,7 @@ public synchronized void removeSerialListener(SerialListener l) {
 
     /**
      * Set up for initialization of a Serial node.
+     * @param node node to initialize.
      */
     public void initializeSerialNode(SerialNode node) {
         synchronized (this) {

java/src/jmri/jmrix/grapevine/nodeconfig/NodeConfigFrame.java

@@ -63,7 +63,8 @@ public class NodeConfigFrame extends jmri.util.JmriJFrame {
     protected String editStatus3 = Bundle.getMessage("NotesEdit3");
 
     /**
-     * Constructor method
+     * Constructor method.
+     * @param _memo system connection.
      */
     public NodeConfigFrame(GrapevineSystemConnectionMemo _memo) {
         super();
@@ -223,6 +224,7 @@ public void actionPerformed(ActionEvent e) {
 
     /**
      * Set the node number.
+     * @param node node address.
      */
     public void setNodeAddress(int node) {
         nodeAddrSpinner.setValue(node);

java/src/jmri/jmrix/grapevine/nodetable/NodeTablePane.java

@@ -44,7 +44,8 @@ public class NodeTablePane extends javax.swing.JPanel implements jmri.jmrix.grap
     private GrapevineSystemConnectionMemo memo = null;
 
     /**
-     * Constructor method
+     * Constructor method.
+     * @param _memo system connection.
      */
     public NodeTablePane(GrapevineSystemConnectionMemo _memo) {
         super();

java/src/jmri/jmrix/grapevine/serialdriver/ConnectionConfig.java

@@ -16,6 +16,7 @@ public class ConnectionConfig extends jmri.jmrix.AbstractSerialConnectionConfig
     /**
      * Ctor for an object being created during load process; Swing init is
      * deferred.
+     * @param p serial port adapter.
      */
     public ConnectionConfig(jmri.jmrix.SerialPortAdapter p) {
         super(p);

java/src/jmri/jmrix/grapevine/simulator/ConnectionConfig.java

@@ -24,6 +24,7 @@ public class ConnectionConfig extends jmri.jmrix.AbstractSimulatorConnectionConf
     /**
      * Ctor for an object being created during load process; Swing init is
      * deferred.
+     * @param p serial port adapter.
      */
     public ConnectionConfig(jmri.jmrix.SerialPortAdapter p) {
         super(p);