Skip to content
Snippets Groups Projects
Commit 699eb338 authored by Brutzman, Don's avatar Brutzman, Don
Browse files

clear javadoc warnings

parent ec48a344
No related branches found
No related tags found
No related merge requests found
Showing
with 30 additions and 22 deletions
...@@ -13,9 +13,9 @@ import java.util.logging.Logger; ...@@ -13,9 +13,9 @@ import java.util.logging.Logger;
public class BRE_KNO_MCC_PC1_MCAST_PduSender public class BRE_KNO_MCC_PC1_MCAST_PduSender
{ {
/* shared variable */ /** shared variable */
public static final String DEFAULT_MULTICAST_ADDRESS = "239.1.2.3"; public static final String DEFAULT_MULTICAST_ADDRESS = "239.1.2.3";
/* shared variable */ /** shared variable */
public static final int DEFAULT_MULTICAST_PORT = 2342; public static final int DEFAULT_MULTICAST_PORT = 2342;
static boolean keepRunning = true; static boolean keepRunning = true;
......
...@@ -117,11 +117,13 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread ...@@ -117,11 +117,13 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread
} }
} }
/** accessor for status */
public void setKeepRunning(boolean k) public void setKeepRunning(boolean k)
{ {
keepRunning = k; keepRunning = k;
} }
/** reset list */
public void resetSavedMCASTMessagesList() public void resetSavedMCASTMessagesList()
{ {
// try // obsolete, undesirable approach // try // obsolete, undesirable approach
...@@ -136,6 +138,7 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread ...@@ -136,6 +138,7 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread
// } // }
} }
/** reset list */
public void resetMcastMessagesToSend() public void resetMcastMessagesToSend()
{ {
// try // obsolete, undesirable approach // try // obsolete, undesirable approach
...@@ -149,7 +152,7 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread ...@@ -149,7 +152,7 @@ public class BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver extends Thread
// Logger.getLogger(BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver.class.getName()).log(Level.SEVERE, null, ex); // Logger.getLogger(BRE_KNO_MCC_PC2_PC1_MCAST_PduReceiver.class.getName()).log(Level.SEVERE, null, ex);
// } // }
} }
/** accessor for list */
public List<Pdu> getMCASTMessagesToSend() public List<Pdu> getMCASTMessagesToSend()
{ {
List<Pdu> temp = null; List<Pdu> temp = null;
......
...@@ -118,6 +118,7 @@ public class BRE_KNO_MCC_PC2_PC3_UNICAST_PduSender extends Thread ...@@ -118,6 +118,7 @@ public class BRE_KNO_MCC_PC2_PC3_UNICAST_PduSender extends Thread
keepRunning = k; keepRunning = k;
} }
/** accessor for list */
public void setListToSend(List<Pdu> pduSetToSend) public void setListToSend(List<Pdu> pduSetToSend)
{ {
// try // obsolete, undesirable approach // try // obsolete, undesirable approach
......
...@@ -194,7 +194,7 @@ public class HittnerNick3 ...@@ -194,7 +194,7 @@ public class HittnerNick3
setNetworkPort(port); setNetworkPort(port);
} }
/** /** accessor for address
* @return the networkAddress * @return the networkAddress
*/ */
public String getNetworkAddress() public String getNetworkAddress()
...@@ -202,7 +202,7 @@ public class HittnerNick3 ...@@ -202,7 +202,7 @@ public class HittnerNick3
return networkAddress; return networkAddress;
} }
/** /** accessor for address
* @param newNetworkAddress the networkAddress to set * @param newNetworkAddress the networkAddress to set
*/ */
public final void setNetworkAddress(String newNetworkAddress) public final void setNetworkAddress(String newNetworkAddress)
...@@ -210,7 +210,7 @@ public class HittnerNick3 ...@@ -210,7 +210,7 @@ public class HittnerNick3
HittnerNick3.networkAddress = newNetworkAddress; HittnerNick3.networkAddress = newNetworkAddress;
} }
/** /** accessor for port
* @return the networkPort * @return the networkPort
*/ */
public int getNetworkPort() public int getNetworkPort()
...@@ -218,7 +218,7 @@ public class HittnerNick3 ...@@ -218,7 +218,7 @@ public class HittnerNick3
return networkPort; return networkPort;
} }
/** /** accessor for port
* @param newNetworkPort the networkPort to set * @param newNetworkPort the networkPort to set
*/ */
public final void setNetworkPort(int newNetworkPort) public final void setNetworkPort(int newNetworkPort)
...@@ -372,14 +372,14 @@ public class HittnerNick3 ...@@ -372,14 +372,14 @@ public class HittnerNick3
System.out.println(TRACE_PREFIX + "complete."); // report successful completion System.out.println(TRACE_PREFIX + "complete."); // report successful completion
} }
/** /** accessor for setting
* @return whether verboseComments mode is enabled * @return whether verboseComments mode is enabled
*/ */
public boolean isVerboseComments() { public boolean isVerboseComments() {
return verboseComments; return verboseComments;
} }
/** /** accessor for setting
* @param newVerboseComments whether verboseComments mode is enabled * @param newVerboseComments whether verboseComments mode is enabled
*/ */
public void setVerboseComments(boolean newVerboseComments) { public void setVerboseComments(boolean newVerboseComments) {
......
...@@ -190,7 +190,7 @@ public class homework3Leckie ...@@ -190,7 +190,7 @@ public class homework3Leckie
setNetworkPort(port); setNetworkPort(port);
} }
/** /** accessor
* @return the networkAddress * @return the networkAddress
*/ */
public String getNetworkAddress() public String getNetworkAddress()
...@@ -198,7 +198,7 @@ public class homework3Leckie ...@@ -198,7 +198,7 @@ public class homework3Leckie
return networkAddress; return networkAddress;
} }
/** /** accessor
* @param newNetworkAddress the networkAddress to set * @param newNetworkAddress the networkAddress to set
*/ */
public final void setNetworkAddress(String newNetworkAddress) public final void setNetworkAddress(String newNetworkAddress)
...@@ -206,7 +206,7 @@ public class homework3Leckie ...@@ -206,7 +206,7 @@ public class homework3Leckie
homework3Leckie.networkAddress = newNetworkAddress; homework3Leckie.networkAddress = newNetworkAddress;
} }
/** /** accessor
* @return the networkPort * @return the networkPort
*/ */
public int getNetworkPort() public int getNetworkPort()
...@@ -214,7 +214,7 @@ public class homework3Leckie ...@@ -214,7 +214,7 @@ public class homework3Leckie
return networkPort; return networkPort;
} }
/** /** accessor
* @param newNetworkPort the networkPort to set * @param newNetworkPort the networkPort to set
*/ */
public final void setNetworkPort(int newNetworkPort) public final void setNetworkPort(int newNetworkPort)
...@@ -367,14 +367,14 @@ public class homework3Leckie ...@@ -367,14 +367,14 @@ public class homework3Leckie
System.out.println(TRACE_PREFIX + "complete."); // report successful completion System.out.println(TRACE_PREFIX + "complete."); // report successful completion
} }
/** /** accessor
* @return whether verboseComments mode is enabled * @return whether verboseComments mode is enabled
*/ */
public boolean isVerboseComments() { public boolean isVerboseComments() {
return verboseComments; return verboseComments;
} }
/** /** accessor
* @param newVerboseComments whether verboseComments mode is enabled * @param newVerboseComments whether verboseComments mode is enabled
*/ */
public void setVerboseComments(boolean newVerboseComments) { public void setVerboseComments(boolean newVerboseComments) {
......
...@@ -222,7 +222,7 @@ public class hw3Robinson { ...@@ -222,7 +222,7 @@ public class hw3Robinson {
setNetworkPort(port); setNetworkPort(port);
} }
/** /** accessor
* @return the networkAddress * @return the networkAddress
*/ */
public String getNetworkAddress() public String getNetworkAddress()
...@@ -230,7 +230,7 @@ public class hw3Robinson { ...@@ -230,7 +230,7 @@ public class hw3Robinson {
return networkAddress; return networkAddress;
} }
/** /** accessor
* @param newNetworkAddress the networkAddress to set * @param newNetworkAddress the networkAddress to set
*/ */
public final void setNetworkAddress(String newNetworkAddress) public final void setNetworkAddress(String newNetworkAddress)
...@@ -238,7 +238,7 @@ public class hw3Robinson { ...@@ -238,7 +238,7 @@ public class hw3Robinson {
hw3Robinson.networkAddress = newNetworkAddress; hw3Robinson.networkAddress = newNetworkAddress;
} }
/** /** accessor
* @return the networkPort * @return the networkPort
*/ */
public int getNetworkPort() public int getNetworkPort()
...@@ -246,7 +246,7 @@ public class hw3Robinson { ...@@ -246,7 +246,7 @@ public class hw3Robinson {
return networkPort; return networkPort;
} }
/** /** accessor
* @param newNetworkPort the networkPort to set * @param newNetworkPort the networkPort to set
*/ */
public final void setNetworkPort(int newNetworkPort) public final void setNetworkPort(int newNetworkPort)
...@@ -406,14 +406,14 @@ public class hw3Robinson { ...@@ -406,14 +406,14 @@ public class hw3Robinson {
System.out.println(TRACE_PREFIX + "complete."); // report successful completion System.out.println(TRACE_PREFIX + "complete."); // report successful completion
} }
/** /** accessor
* @return whether verboseComments mode is enabled * @return whether verboseComments mode is enabled
*/ */
public boolean isVerboseComments() { public boolean isVerboseComments() {
return verboseComments; return verboseComments;
} }
/** /** accessor
* @param newVerboseComments whether verboseComments mode is enabled * @param newVerboseComments whether verboseComments mode is enabled
*/ */
public void setVerboseComments(boolean newVerboseComments) { public void setVerboseComments(boolean newVerboseComments) {
......
...@@ -10,7 +10,7 @@ public class DuranTcpExample3Client { ...@@ -10,7 +10,7 @@ public class DuranTcpExample3Client {
/** main method for execution /** main method for execution
* @param args arguments * @param args arguments
* @throws java.lang.InterruptedException */ * @throws java.lang.InterruptedException when cancelled */
public static void main(String[] args) throws InterruptedException { public static void main(String[] args) throws InterruptedException {
// Local variables/fields // Local variables/fields
......
...@@ -25,7 +25,9 @@ public class Homework2 ...@@ -25,7 +25,9 @@ public class Homework2
/* **************************** infrastructure code, modification is seldom needed ************************* */ /* **************************** infrastructure code, modification is seldom needed ************************* */
private String descriptor = this.getClass().getSimpleName(); private String descriptor = this.getClass().getSimpleName();
/** utility class */
protected DisChannel disChannel; protected DisChannel disChannel;
/** utility class */
protected PduFactory pduFactory; protected PduFactory pduFactory;
/** seconds for real-time execution (not simulation time, which may or may not be .the same) */ /** seconds for real-time execution (not simulation time, which may or may not be .the same) */
...@@ -64,6 +66,8 @@ public class Homework2 ...@@ -64,6 +66,8 @@ public class Homework2
{ {
initialize(); initialize();
} }
/** constructor
* @param newDescriptor initial descriptor*/
public Homework2(String newDescriptor) public Homework2(String newDescriptor)
{ {
descriptor = newDescriptor; descriptor = newDescriptor;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment