cleanup of javadoc errors and warnings

src/fitnesse/testsystems/slim/tables/ScriptTable.java

@@ -21,62 +21,82 @@ public class ScriptTable extends SlimTable {
   public ScriptTable(Table table, String tableId, SlimTestContext context) {
     super(table, tableId, context);
   }
-
+  /**
+   * Template method to provide the keyword that identifies the table type.
+   *
+   * @return table type
+   */
   protected String getTableType() {
     return "scriptTable";
   }
 
   /**
    * Template method to provide the keyword that identifies the table type.
+   *
+   * @return keyword for script table
    */
   protected String getTableKeyword() {
     return "script";
   }
 
   /**
    * Template method to provide the keyword for the {@code start} action.
+   *
+   * @return keyword for {@code start} action
    */
   protected String getStartKeyword() {
     return "start";
   }
 
   /**
    * Template method to provide the keyword for the {@code check} action.
+   *
+   * @return keyword for {@code check} action
    */
   protected String getCheckKeyword() {
     return "check";
   }
 
   /**
    * Template method to provide the keyword for the {@code checkNot} action.
+   *
+   * @return keyword for {@code checkNot} action
    */
   protected String getCheckNotKeyword() {
     return "check not";
   }
 
   /**
    * Template method to provide the keyword for the {@code reject} action.
+   *
+   * @return keyword for {@code reject} action
    */
   protected String getRejectKeyword() {
     return "reject";
   }
 
   /**
    * Template method to provide the keyword for the {@code ensure} action.
+   *
+   * @return keyword for {@code ensure} action
    */
   protected String getEnsureKeyword() {
     return "ensure";
   }
 
   /**
    * Template method to provide the keyword for the {@code show} action.
+   *
+   * @return keyword for {@code show} action
    */
   protected String getShowKeyword() {
     return "show";
   }
 
   /**
    * Template method to provide the keyword for the {@code note} action.
+   *
+   * @return keyword for {@code note} action
    */
   protected String getNoteKeyword() {
     return "note";

src/fitnesse/testsystems/slim/tables/SlimAssertion.java

@@ -40,8 +40,9 @@ public String toString() {
 
   /**
    * Get Instructions from the assertions; NOOP's are filtered out.
-   * @param assertions
-   * @return
+   *
+   * @param assertions List of SlimAssertions to filter
+   * @return all instructions from the input without NOOP's
    */
   public static List<Instruction> getInstructions(List<SlimAssertion> assertions) {
     List<Instruction> instructions = new ArrayList<Instruction>(assertions.size());

src/fitnesse/util/HtmlParserTools.java

@@ -17,7 +17,10 @@ private HtmlParserTools() {
   }
 
   /**
-   * Clone just this one node. No nesting
+   * Make flat clone of just this one node. No nesting
+   *
+   * @param node Node to clone
+   * @return cloned version of node
    */
   public static Node flatClone(Node node) {
     if (node == null) return null;
@@ -30,10 +33,10 @@ public static Node flatClone(Node node) {
   }
 
   /**
-   * Make a 1:1 clone of the NodeList.
+   * Make a 1:1 clone of a list of Nodes
    *
-   * @param nodeList
-   * @return
+   * @param nodeList NodeList to clone
+   * @return cloned version of NodeList
    */
   public static NodeList deepClone(NodeList nodeList) {
     return deepClone(nodeList, null);
@@ -42,16 +45,17 @@ public static NodeList deepClone(NodeList nodeList) {
   /**
    * Make a 1:1 clone of the Node.
    *
-   * @param node
-   * @return
+   * @param node Node to deepclone
+   * @param <T> Node of child of Node
+   * @return deepcloned version of node
    */
   public static <T extends Node> T deepClone(T node) {
     return (T) deepClone(new NodeList(node), null).elementAt(0);
   }
 
   /**
    * Get closing node for this node, if any.
-   * @param node
+   * @param node Node to find closing sibling for
    * @return node or null
    */
   public static Node endTag(Node node) {

src/fitnesse/wiki/WikiPage.java

@@ -22,6 +22,7 @@ public interface WikiPage extends Comparable<Object> {
 
   /**
    * Get child pages for this wiki page
+   *
    * @return children, an empty list if there are none.
    */
   List<WikiPage> getChildren();
@@ -32,6 +33,7 @@ public interface WikiPage extends Comparable<Object> {
 
   /**
    * Get a list/set of version info
+   *
    * @return a collection, never null.
    */
   Collection<VersionInfo> getVersions();
@@ -42,7 +44,8 @@ public interface WikiPage extends Comparable<Object> {
 
   /**
    * Commit new content
-   * @param data
+   *
+   * @param data PageData to commit
    * @return version information about this new data version, may be null.
    */
   VersionInfo commit(PageData data);

src/fitnesse/wiki/fs/VersionsController.java

@@ -9,7 +9,8 @@
 public interface VersionsController {
 
   /**
-   * Obtain data for the files requested at a specific revision,
+   * Obtain data for the files requested at a specific revision
+   *
    * @param revision The revision to look for
    * @param files Files to obtain data for
    * @return An array of FileVersion elements is returned. The size is equal to the number of files requested,
@@ -19,40 +20,43 @@ public interface VersionsController {
 
   /**
    * Get history information for a set of files.
+   *
    * @param files Files to look for.
    * @return history
    */
   Collection<? extends VersionInfo> history(File... files);
 
   /**
    * Store files as one revision.
+   *
    * @param fileVersion The files to store
    * @return Version information. VersionInfo.label should refer to this revision, so it can be retrieved later.
-   * @throws IOException
+   * @throws IOException IOException
    */
   VersionInfo makeVersion(FileVersion... fileVersion) throws IOException;
 
   /**
    * Add a directory. We only add them one at a time.
-   * @param filePath
-   * @return
-   * @throws IOException
+   *
+   * @param filePath  directory to add
+   * @return  VersionInfo
+   * @throws IOException IOException
    */
   VersionInfo addDirectory(final FileVersion filePath) throws IOException;
 
   /**
    * Rename a file. Used for the files/ section. No author information is stored here.
    *
-   *
    * @param fileVersion File to rename to.
    * @param originalFile The original file.
-   * @throws IOException
+   * @throws IOException IOException
    */
   void rename(FileVersion fileVersion, File originalFile) throws IOException;
 
   /**
    * Delete a bunch of files.
-   * @param files
+   *
+   * @param files files to delete
    */
   void delete(FileVersion... files);
 }

src/fitnesseMain/ant/ExecuteFitnesseTestsTask.java

@@ -146,112 +146,116 @@ private void appendSuiteFilter(CommandlineJava cmd) {
   }
 
   /**
-   * Host address on which Fitnesse is running. Defaults to 'localhost'.
+   * Set host address on which Fitnesse is running. Defaults to 'localhost'.
    *
-   * @param fitnesseHost
+   * @param fitnesseHost host address on which Fitnesse is running
    */
   public void setFitnesseHost(String fitnesseHost) {
     this.fitnesseHost = fitnesseHost;
   }
 
   /**
-   * Classpath of the TestRunner class. <b>MUST SET</b>
+   * Set Classpath of the TestRunner class. <b>MUST SET</b>
    *
-   * @param classpath
+   * @param classpath Classpath of the TestRunner class
    */
   public void setClasspath(Path classpath) {
     this.classpath = classpath;
   }
 
   /**
-   * Name of the filter to be passed to TestRunner to specify a subset of tests to run.
+   * Set name of the filter to be passed to TestRunner to specify a subset of tests to run.
    *
-   * @param suiteFilter
+   * @param suiteFilter name of the filter to be passed to TestRunner for filtering
    */
   public void setSuiteFilter(String suiteFilter) {
     this.suiteFilter = suiteFilter;
   }
 
   /**
-   * Debug mode. Defaults to 'true'.
+   * Set debug mode. Defaults to 'true'.
    *
-   * @param debug
+   * @param debug enable or disable debug mode
    */
   public void setDebug(boolean debug) {
     this.debug = debug;
   }
 
   /**
-   * Will fail the build if any Fitnesse tests fail. Defaults to 'true'.
+   * Enable or disable to fail the build if any Fitnesse tests fail. Defaults to 'true'.
    *
-   * @param failOnError
+   * @param failOnError Enable or disable to fail the build if any Fitnesse tests fail
    */
   public void setFailOnError(boolean failOnError) {
     this.failOnError = failOnError;
   }
 
   /**
-   * Port on which fitnesse would run. <b>MUST SET.</b>.
+   * Set port on which fitnesse would run. <b>MUST SET.</b>.
    *
-   * @param fitnessePort
+   * @param fitnessePort port on which fitnesse would run
    */
   public void setFitnessePort(int fitnessePort) {
     this.fitnessePort = fitnessePort;
   }
 
   /**
-   * Name of the property which will store the test results. Only valid if failOnError attribute is set to false.
+   * Set name of the property which will store the test results. Only valid if failOnError attribute is set to false.
    *
-   * @param resultProperty
+   * @param resultProperty name of the property which will store the test results
    */
   public void setResultProperty(String resultProperty) {
     this.resultProperty = resultProperty;
   }
 
   /**
-   * Path to the folder that will contain the fitnesse results page after execution. Only valid if resultsHTMLPage or
+   * Set the path to the folder that will contain the fitnesse results page after execution. Only valid if resultsHTMLPage or
    * resultsXMLPage attributes are set. Defaults to current directory.
    *
-   * @param resultsDir
+   * @param resultsDir path to the folder that will contain the fitnesse results page after execution.
    */
   public void setResultsDir(String resultsDir) {
     this.resultsDir = resultsDir;
   }
 
   /**
+   * Set the filename for storing the results in HTML format
+   *
    * If set, stores the fitnesse results in HTML format under the resultsdir folder with the given name. The file name
    * must have a '.html' extension.
    *
-   * @param resultsHTMLPage
+   * @param resultsHTMLPage set the filename for storing the results in HTML format
    */
   public void setResultsHTMLPage(String resultsHTMLPage) {
     this.resultsHTMLPage = resultsHTMLPage;
   }
 
   /**
+   * Set the filename for storing the results in XML format
+   *
    * If set, stores the fitnesse results in XML format under the resultsdir folder with the given name. The file name
    * must have a '.xml' extension.
    *
-   * @param resultsXMLPage
+   * @param resultsXMLPage set the filename for storing the results in XML format
    */
   public void setResultsXMLPage(String resultsXMLPage) {
     this.resultsXMLPage = resultsXMLPage;
   }
 
   /**
-   * Fully qualifies class name of the fitnesse testrunner class. Defaults to 'fitnesse.runner.TestRunner'.
+   * Set the fully qualifies class name of the fitnesse testrunner class. Defaults to 'fitnesse.runner.TestRunner'.
    *
-   * @param runnerClass
+   * @param runnerClass Fully qualifies class name of the fitnesse testrunner class
    */
   public void setTestRunnerClass(String runnerClass) {
     testRunnerClass = runnerClass;
   }
 
   /**
-   * Partial URL of the wiki page which is declared as a Suite. Ex: FrontPage.SmokeTest,
+   * Set the partial URL of the wiki page which is declared as a Suite. Ex: FrontPage.SmokeTest,
    * FitNesse.SuiteAcceptanceTests, or FitNesse.AcceptanceTestsSuite. <b>MUST SET.</b>
    *
-   * @param suitePage
+   * @param suitePage  partial URL of the wiki page which is declared as a Suite
    */
   public void setSuitePage(String suitePage) {
     this.suitePage = suitePage;
@@ -260,7 +264,7 @@ public void setSuitePage(String suitePage) {
   /**
    * Set verbose mode. Defaults to 'true'.
    *
-   * @param verbose
+   * @param verbose verbose mode
    */
   public void setVerbose(boolean verbose) {
     this.verbose = verbose;