Merge pull request #62 from LHuang2019/pathlinker-37

Refs #37: Update comments to fix maven build error on javadoc

Author: jlaw9

src/main/java/com/dpgil/pathlinker/path_linker/internal/rest/PathLinkerAppResponse.java

@@ -36,15 +36,15 @@ public Long getSubnetworkSUID() {
 
     /**
      * Setter method of the subnetworkSUID
-     * @param subnetworkSUID
+     * @param subnetworkSUID the SUID of the subnetwork generated
      */
     public void setSubNetworkSUID(Long subnetworkSUID) {
         this.subnetworkSUID = subnetworkSUID;
     }
 
     /**
      * Getter method of the subnetworkViewSUID
-     * @return subnetworkViewSUID
+     * @return subnetworkViewSUID the SUID of the subnetwork view generated
      */
     @ApiModelProperty(value = "SUID of the subnetwork view created")
     public Long getSubnetworkViewSUID() {
@@ -53,15 +53,15 @@ public Long getSubnetworkViewSUID() {
 
     /**
      * Setter method of the subnetworkViewSUID
-     * @param subnetworkViewSUID
+     * @param subnetworkViewSUID the SUID of the subnetwork view generated
      */
     public void setSubnetworkViewSUID(Long subnetworkViewSUID) {
         this.subnetworkViewSUID = subnetworkViewSUID;
     }
 
     /**
      * Getter method of the pathRankColumnName
-     * @return the pathRankColumnName
+     * @return the pathRankColumnName the path rank column name
      */
     @ApiModelProperty(value = "The name of the edge column containing the rank of the first path in which a given edge appears",
             example = "path rank 1")
@@ -71,15 +71,15 @@ public String getPathRankColumnName() {
 
     /**
      * Setter method of the pathRankColumnName
-     * @param pathRankColumnName
+     * @param pathRankColumnName the path rank column name corresponding to the subnetwork
      */
     public void setPathRankColumnName(String pathRankColumnName) {
         this.pathRankColumnName = pathRankColumnName;
     }
 
     /**
      * Getter method of the paths
-     * @return paths
+     * @return paths the path generated by the algorithm
      */
     @ApiModelProperty(value = "List of paths generated by the algorithm", required = true)
     public List<Path> getPaths() {
@@ -88,7 +88,7 @@ public List<Path> getPaths() {
 
     /**
      * Setter method of the paths
-     * @param paths
+     * @param paths the path generated by the algorithm
      */
     public void setPaths(List<Path> paths) {
         this.paths = paths;

src/main/java/com/dpgil/pathlinker/path_linker/internal/rest/PathLinkerImpl.java

@@ -61,7 +61,6 @@ public class PathLinkerImpl implements PathLinkerResource {
      * @param serviceRegistrar      service registrar
      * @param cySwingApp            swing app
      * @param ciExceptionFactory    CIException factory
-     * @param ciErrorFactory        CIError factory
      */
     public PathLinkerImpl(
             PathLinkerControlPanel controlPanel,

src/main/java/com/dpgil/pathlinker/path_linker/internal/rest/PathLinkerResource.java

@@ -23,9 +23,10 @@
 public interface PathLinkerResource {
 
     /**
-     * Post Function that takes user input, and runs PathLinker on specific network;
+     * Post Function that takes user input, and runs PathLinker on specific network; 
      *      generate new network/network view, 
      *      and return network/view SUIDs and k-number sorted path list
+     * @param networkSUID the SUID of the network the function will run on
      * @param modelParams parameters needed to generate a network
      * @return k-number sorted path list in JSON Array format
      */

src/main/java/com/dpgil/pathlinker/path_linker/internal/util/Algorithms.java

@@ -159,11 +159,13 @@ public int compareTo(PathWay o) {
 	 * edge between any two nodes). A* is used as the pathfinding subroutine,
 	 * with the distances in the input graph as a heuristic. Because the
 	 * algorithm computes paths over subsets of the initial heuristic is valid
-	 * and effective. If the graph contains n < k paths, n paths will be
+	 * and effective. If the graph contains n less than k paths, n paths will be
 	 * returned.
 	 *
 	 * @param network
 	 *            the supplied network
+	 * @param cyNodeToId
+     *            the map that maps CyNode object to its string name
 	 * @param source
 	 *            the source node
 	 * @param target
@@ -380,6 +382,8 @@ private static void resetHiddenEdges()
 	 *
 	 * @param network
 	 *            the supplied network
+	 * @param cyNodeToId
+     *            the map that maps CyNode object to its string name
 	 * @param source
 	 *            the source node
 	 * @param target
@@ -658,6 +662,8 @@ public static HashMap<CyNode, Double> singleSourceDijkstra(
 	 *
 	 * @param network
 	 *            the network
+	 * @param cyNodeToId
+     *            the map that maps CyNode object to its string name
 	 * @param source
 	 *            the source node of the graph
 	 * @param target

src/main/java/com/dpgil/pathlinker/path_linker/internal/view/TextFieldInputFilter.java

@@ -30,7 +30,7 @@ public void insertString(FilterBypass fb, int offset, String string,
     /**
      * Validate method
      *      To be implemented depend on the data type for the validation
-     * @param input text from the text field
+     * @param text input text from the text field
      * @return true if validate pass, otherwise false
      */
     public abstract boolean validate(String text);