From 959c02a7e640fb700d267b3f2968a4eb1eed2e47 Mon Sep 17 00:00:00 2001 From: Kyle Lieber Date: Tue, 13 Sep 2016 19:41:05 -0500 Subject: [PATCH] fixing javadoc issues --- .../jasmine/mojo/AbstractJasmineMojo.java | 22 +++++++++---------- .../github/searls/jasmine/mojo/TestMojo.java | 14 ++++++------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/main/java/com/github/searls/jasmine/mojo/AbstractJasmineMojo.java b/src/main/java/com/github/searls/jasmine/mojo/AbstractJasmineMojo.java index e7c2e7ed6..db1675cf2 100644 --- a/src/main/java/com/github/searls/jasmine/mojo/AbstractJasmineMojo.java +++ b/src/main/java/com/github/searls/jasmine/mojo/AbstractJasmineMojo.java @@ -51,14 +51,14 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin * before other sources (and specs) in a particular order. Each source will first be * searched for relative to ${jsSrcDir}, then ${jsTestSrcDir}, * then (if it's not found in either) it will be included exactly as it appears in your POM.

- *

+ *
*

Therefore, if jquery.js is in ${jsSrcDir}/vendor, you would configure:

* 
    * <preloadSources>
    *   <source>vendor/jquery.js</source>
    * </preloadSources>
    *
- *

+ *
*

And jquery.js would load before all the other sources and specs.

* * @since 1.1.0 @@ -71,11 +71,11 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin * and as a result the generated SpecRunner HTML files are set up in a way that you can't run * your specs. Have no fear! Simply specify a custom spec runner template in the plugin configuration * and make the changes you need.

- *

+ *
*

Potential values are a filesystem path, a URL, or a classpath resource. The default template is * stored in src/main/resources/jasmine-templates/SpecRunner.htmltemplate, and the * required template strings are tokenized in "$*$" patterns.

- *

+ *
*

Example usage:

* 
    * <customRunnerTemplate>${project.basedir}/src/test/resources/myCustomRunner.template</customRunnerTemplate>
@@ -90,7 +90,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
    * 
Sometimes you want to have full control over how scriptloaders are configured. In order to
    * interpolate custom configuration into the generated runnerTemplate, specify a file containing
    * the additional config. Potential values are a filesystem path, a URL, or a classpath resource.

-   * 

+   * 

    * 
Example usage:

    * 
    * <customRunnerConfiguration>${project.basedir}/src/test/resources/myCustomConfig.txt</customRunnerConfiguration>
@@ -245,7 +245,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
    *   <include>**/*.coffee</include>
    * </sourceIncludes>
    * 

-   * 

+   * 

    * 
Default sourceIncludes:

    * 
    * <sourceIncludes>
@@ -279,7 +279,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
    *   <include>**/*.coffee</include>
    * </specIncludes>
    * 

-   * 

+   * 

    * 
Default specIncludes:

    * 
    * <specIncludes>
@@ -304,7 +304,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
 
   /**
    * 
Used by the jasmine:bdd goal to specify port to run the server under.

-   * 

+   * 

    * 
The jasmine:test goal always uses a random available port so this property is ignored.

    *
    * @since 1.1.0
@@ -322,7 +322,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
 
   /**
    * 
Not used by the jasmine:bdd goal.

-   * 

+   * 

    * 
The jasmine:test goal to specify hostname where the server is running.  Useful when using
    * the RemoteWebDriver.

    *
@@ -334,7 +334,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
   /**
    * 
Determines the strategy to use when generation the JasmineSpecRunner. This feature allows for custom
    * implementation of the runner generator. Typically this is used when using different script runners.

-   * 

+   * 

    * 
Some valid examples: DEFAULT, REQUIRE_JS

    *
    * @since 1.1.0
@@ -363,7 +363,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
 
   /**
    * 
Type of {@link org.eclipse.jetty.server.Connector} to use on the jetty server.

-   * 

+   * 

    * 
Most users won't need to change this from the default value. It should only be used
    * by advanced users.

    *
diff --git a/src/main/java/com/github/searls/jasmine/mojo/TestMojo.java b/src/main/java/com/github/searls/jasmine/mojo/TestMojo.java
index 260da2b35..5a6c1615e 100644
--- a/src/main/java/com/github/searls/jasmine/mojo/TestMojo.java
+++ b/src/main/java/com/github/searls/jasmine/mojo/TestMojo.java
@@ -42,7 +42,7 @@ public class TestMojo extends AbstractJasmineMojo {
   /**
    * Determines the Selenium WebDriver class we'll use to execute the tests. See the Selenium documentation for more details.
    * The plugin uses PhantomJSDriver by default.
-   * 

+   * 

    * 
Some valid examples:

    * 
    
    * 
  • org.openqa.selenium.htmlunit.HtmlUnitDriver
    • 
@@ -50,7 +50,7 @@ public class TestMojo extends AbstractJasmineMojo {
    * 
  • org.openqa.selenium.firefox.FirefoxDriver
    • 
    * 
  • org.openqa.selenium.ie.InternetExplorerDriver
    • 
    * 

-   * 

+   * 

    * See the webDriverCapabilities property for configuring driver specific properties.
    *
    * @since 1.1.0
@@ -60,9 +60,9 @@ public class TestMojo extends AbstractJasmineMojo {
 
   /**
    * 
Web driver capabilities used to initialize a DesiredCapabilities instance when creating a web driver.

-   * 

+   * 

    * 
Capabilities value can be either a String, a List, or a Map.

-   * 

+   * 

    * 
Example:

    * 
    * <webDriverCapabilities>
@@ -94,7 +94,7 @@ public class TestMojo extends AbstractJasmineMojo {
   /**
    * 
Determines the browser and version profile that HtmlUnit will simulate. This setting does nothing if the plugin is configured not to use HtmlUnit.
    * This maps 1-to-1 with the public static instances found in {@link com.gargoylesoftware.htmlunit.BrowserVersion}.

-   * 

+   * 

    * 
Some valid examples: CHROME, FIREFOX_17, INTERNET_EXPLORER_9, INTERNET_EXPLORER_10

    *
    * @since 1.1.0
@@ -119,10 +119,10 @@ public class TestMojo extends AbstractJasmineMojo {
 
   /**
    * 
Configure which version of PhantomJS should be used and how it should be found. The core of the
-   * phantomjs-maven-plugin is used to provide this
+   * phantomjs-maven-plugin is used to provide this
    * functionality and this parameter should match the configuration of the
    * phantomjs-maven-plugin install goal.

-   * 

+   * 

    * 
Default Options:

    * 
    * <phantomjs>