fix some doclint errors and exclude impl package from javadoc output

TNG · Apr 12, 2015 · e45d95f · e45d95f
1 parent 697b5b5
commit e45d95f
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 6 deletions.
diff --git a/build.gradle b/build.gradle
@@ -126,6 +126,10 @@ subprojects {
         }
    }
 
+   javadoc {
+        exclude '**/impl/**'
+   }
+
     checkstyle {
         configFile = file("${rootProject.projectDir}/develop/checkstyle-rules.xml")
         showViolations = false

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/DataTables.java b/jgiven-core/src/main/java/com/tngtech/jgiven/DataTables.java
@@ -11,7 +11,7 @@ public class DataTables {
 
     /**
      * Creates a table, i.e. a list of lists, with {@code numberOfColumns} columns from the given {@code data} including the header.
-     * <p/>
+     * <p>
      * Example:
      * <pre>{@code
      *     table(2,

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/annotation/Table.java b/jgiven-core/src/main/java/com/tngtech/jgiven/annotation/Table.java
@@ -105,7 +105,6 @@
      *     | b1 | b2 | b3 |
      *     | c1 | c2 | c3 |
      * </pre>
-     * </p>
      *
      * <h2>Effect on POJO lists</h2>
      * When the data is given by a list of POJOs then setting the header type to {@code VERTICAL} will also
@@ -116,7 +115,7 @@
      *         new CoffeeWithPrice("Espresso", 2.0),
      *         new CoffeeWithPrice("Cappuccino", 2.5)}
      * }</pre>
-     * When setting the header type to {@code VERTICAL}</br>
+     * When setting the header type to {@code VERTICAL}<br>
      * Then the report will present the following table
      * <pre>{@code
      *     | name         | Espresso | Cappuccino |

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/base/StageBase.java b/jgiven-core/src/main/java/com/tngtech/jgiven/base/StageBase.java
@@ -27,12 +27,12 @@ public SELF self() {
      * A step method for creating ad-hoc steps using lambdas.
      *
      * <h2>Example Usage</h2>
-     * <pre>
+     * <pre>{@code 
      *     given().$( "Two negative arguments", stage -> {
      *        stage.given().argument( -5 )
      *             .and().argument( -6 );
      *     });
-     * </pre>
+     * }</pre>
      *
      * @param description the description of the step
      * @param function the implementation of the step in form of a function where the parameter is the stage the step is executed in

diff --git a/jgiven-core/src/main/java/com/tngtech/jgiven/report/ReportModelHandler.java b/jgiven-core/src/main/java/com/tngtech/jgiven/report/ReportModelHandler.java
@@ -29,7 +29,7 @@ public interface ReportModelHandler {
 
     /**
      * Is invoked when a scenario has multiple cases, but no data table.
-     * <p/>
+     * <p>
      * Plain Text Example:
      * <pre>
      *   Case 1: param1 = arg1, param2 = arg2