Skip to content

Commit

Permalink
fixing javadoc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
klieber committed Sep 14, 2016
1 parent 0093885 commit 959c02a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>${jsSrcDir}</code>, then <code>${jsTestSrcDir}</code>,
* then (if it's not found in either) it will be included exactly as it appears in your POM.</p>
* <p/>
* <br>
* <p>Therefore, if jquery.js is in <code>${jsSrcDir}/vendor</code>, you would configure:</p>
* <pre>
* &lt;preloadSources&gt;
* &lt;source&gt;vendor/jquery.js&lt;/source&gt;
* &lt;/preloadSources&gt;
* </pre>
* <p/>
* <br>
* <p>And jquery.js would load before all the other sources and specs.</p>
*
* @since 1.1.0
Expand All @@ -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.</p>
* <p/>
* <br>
* <p>Potential values are a filesystem path, a URL, or a classpath resource. The default template is
* stored in <code>src/main/resources/jasmine-templates/SpecRunner.htmltemplate</code>, and the
* required template strings are tokenized in "$*$" patterns.</p>
* <p/>
* <br>
* <p>Example usage:</p>
* <pre>
* &lt;customRunnerTemplate&gt;${project.basedir}/src/test/resources/myCustomRunner.template&lt;/customRunnerTemplate&gt;
Expand All @@ -90,7 +90,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
* <p>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.</p>
* <p/>
* <br>
* <p>Example usage:</p>
* <pre>
* &lt;customRunnerConfiguration&gt;${project.basedir}/src/test/resources/myCustomConfig.txt&lt;/customRunnerConfiguration&gt;
Expand Down Expand Up @@ -245,7 +245,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
* &lt;include&gt;&#42;&#42;/&#42;.coffee&lt;/include&gt;
* &lt;/sourceIncludes&gt;
* </pre>
* <p/>
* <br>
* <p>Default <code>sourceIncludes</code>:</p>
* <pre>
* &lt;sourceIncludes&gt;
Expand Down Expand Up @@ -279,7 +279,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
* &lt;include&gt;&#42;&#42;/&#42;.coffee&lt;/include&gt;
* &lt;/specIncludes&gt;
* </pre>
* <p/>
* <br>
* <p>Default <code>specIncludes</code>:</p>
* <pre>
* &lt;specIncludes&gt;
Expand All @@ -304,7 +304,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin

/**
* <p>Used by the <code>jasmine:bdd</code> goal to specify port to run the server under.</p>
* <p/>
* <br>
* <p>The <code>jasmine:test</code> goal always uses a random available port so this property is ignored.</p>
*
* @since 1.1.0
Expand All @@ -322,7 +322,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin

/**
* <p>Not used by the <code>jasmine:bdd</code> goal.</p>
* <p/>
* <br>
* <p>The <code>jasmine:test</code> goal to specify hostname where the server is running. Useful when using
* the RemoteWebDriver.</p>
*
Expand All @@ -334,7 +334,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin
/**
* <p>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.</p>
* <p/>
* <br>
* <p>Some valid examples: DEFAULT, REQUIRE_JS</p>
*
* @since 1.1.0
Expand Down Expand Up @@ -363,7 +363,7 @@ public abstract class AbstractJasmineMojo extends AbstractMojo implements Jasmin

/**
* <p>Type of {@link org.eclipse.jetty.server.Connector} to use on the jetty server.</p>
* <p/>
* <br>
* <p>Most users won't need to change this from the default value. It should only be used
* by advanced users.</p>
*
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/com/github/searls/jasmine/mojo/TestMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ 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 <a href="https://github.com/detro/ghostdriver">PhantomJSDriver</a> by default.
* <p/>
* <br>
* <p>Some valid examples:</p>
* <ul>
* <li>org.openqa.selenium.htmlunit.HtmlUnitDriver</li>
* <li>org.openqa.selenium.phantomjs.PhantomJSDriver</li>
* <li>org.openqa.selenium.firefox.FirefoxDriver</li>
* <li>org.openqa.selenium.ie.InternetExplorerDriver</li>
* </ul>
* <p></p>
* <br>
* See the webDriverCapabilities property for configuring driver specific properties.
*
* @since 1.1.0
Expand All @@ -60,9 +60,9 @@ public class TestMojo extends AbstractJasmineMojo {

/**
* <p>Web driver capabilities used to initialize a DesiredCapabilities instance when creating a web driver.</p>
* <p/>
* <br>
* <p>Capabilities value can be either a String, a List, or a Map.</p>
* <p/>
* <br>
* <p>Example:</p>
* <pre>
* &lt;webDriverCapabilities&gt;
Expand Down Expand Up @@ -94,7 +94,7 @@ public class TestMojo extends AbstractJasmineMojo {
/**
* <p>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}.</p>
* <p/>
* <br>
* <p>Some valid examples: CHROME, FIREFOX_17, INTERNET_EXPLORER_9, INTERNET_EXPLORER_10</p>
*
* @since 1.1.0
Expand All @@ -119,10 +119,10 @@ public class TestMojo extends AbstractJasmineMojo {

/**
* <p>Configure which version of PhantomJS should be used and how it should be found. The core of the
* <a href="http://klieber.github.io/phantomjs-maven-plugin"></a>phantomjs-maven-plugin</a> is used to provide this
* <a href="http://klieber.github.io/phantomjs-maven-plugin">phantomjs-maven-plugin</a> is used to provide this
* functionality and this parameter should match the configuration of the
* <a href="http://kylelieber.com/phantomjs-maven-plugin/install-mojo.html">phantomjs-maven-plugin install</a> goal.</p>
* <p/>
* <br>
* <p>Default Options:</p>
* <pre>
* &lt;phantomjs&gt;
Expand Down

0 comments on commit 959c02a

Please sign in to comment.