Skip to content

Commit

Permalink
Improve generated javadoc comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
joel-costigliola committed Jul 17, 2016
1 parent 0f7f8fd commit 76d6923
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 20 deletions.
@@ -1,8 +1,7 @@
package ${package};

/**
* Entry point for BDD assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for BDD assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class BddAssertions {
Expand Down
@@ -1,8 +1,7 @@
package ${package};

/**
* Entry point for BDD soft assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for BDD soft assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class BDDSoftAssertions extends org.assertj.core.api.BDDSoftAssertions {
Expand Down
@@ -1,8 +1,8 @@
package ${package};

/**
* Like {@link SoftAssertions} but as a junit rule which can be used without having to call
* {@link SoftAssertions#assertAll() assertAll()},
* Like {@link BDDSoftAssertions} but as a junit rule that takes care of calling
* {@link SoftAssertions#assertAll() assertAll()} at the end of each test.
* <p>
* Example:
* <pre><code class='java'> public class SoftlyTest {
Expand All @@ -14,6 +14,7 @@ package ${package};
* public void soft_bdd_assertions() throws Exception {
* softly.then(1).isEqualTo(2);
* softly.then(Lists.newArrayList(1, 2)).containsOnly(1, 2);
* // no need to call assertAll(), this is done automatically.
* }
* }</code></pre>
*/
Expand Down
@@ -1,8 +1,22 @@
package ${package};

/**
* Entry point for assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Like {@link SoftAssertions} but as a junit rule that takes care of calling
* {@link SoftAssertions#assertAll() assertAll()} at the end of each test.
* <p>
* Example:
* <pre><code class='java'> public class SoftlyTest {
*
* &#064;Rule
* public final JUnitBDDSoftAssertions softly = new JUnitBDDSoftAssertions();
*
* &#064;Test
* public void soft_bdd_assertions() throws Exception {
* softly.assertThat(1).isEqualTo(2);
* softly.assertThat(Lists.newArrayList(1, 2)).containsOnly(1, 2);
* // no need to call assertAll(), this is done automatically.
* }
* }</code></pre>
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class JUnitSoftAssertions extends org.assertj.core.api.JUnitSoftAssertions {
Expand Down
@@ -1,8 +1,7 @@
package ${package};

/**
* Entry point for assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for soft assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class SoftAssertions extends org.assertj.core.api.SoftAssertions {
Expand Down
3 changes: 1 addition & 2 deletions src/test/resources/BDDSoftAssertions.expected.txt
@@ -1,8 +1,7 @@
package org.assertj.assertions.generator.data;

/**
* Entry point for BDD soft assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for BDD soft assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class BDDSoftAssertions extends org.assertj.core.api.BDDSoftAssertions {
Expand Down
3 changes: 1 addition & 2 deletions src/test/resources/BddAssertions.expected.txt
@@ -1,8 +1,7 @@
package org.assertj.assertions.generator.data;

/**
* Entry point for BDD assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for BDD assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class BddAssertions {
Expand Down
5 changes: 3 additions & 2 deletions src/test/resources/JUnitBDDSoftAssertions.expected.txt
@@ -1,8 +1,8 @@
package org.assertj.assertions.generator.data;

/**
* Like {@link SoftAssertions} but as a junit rule which can be used without having to call
* {@link SoftAssertions#assertAll() assertAll()},
* Like {@link BDDSoftAssertions} but as a junit rule that takes care of calling
* {@link SoftAssertions#assertAll() assertAll()} at the end of each test.
* <p>
* Example:
* <pre><code class='java'> public class SoftlyTest {
Expand All @@ -14,6 +14,7 @@ package org.assertj.assertions.generator.data;
* public void soft_bdd_assertions() throws Exception {
* softly.then(1).isEqualTo(2);
* softly.then(Lists.newArrayList(1, 2)).containsOnly(1, 2);
* // no need to call assertAll(), this is done automatically.
* }
* }</code></pre>
*/
Expand Down
18 changes: 16 additions & 2 deletions src/test/resources/JUnitSoftAssertions.expected.txt
@@ -1,8 +1,22 @@
package org.assertj.assertions.generator.data;

/**
* Entry point for assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Like {@link SoftAssertions} but as a junit rule that takes care of calling
* {@link SoftAssertions#assertAll() assertAll()} at the end of each test.
* <p>
* Example:
* <pre><code class='java'> public class SoftlyTest {
*
* &#064;Rule
* public final JUnitBDDSoftAssertions softly = new JUnitBDDSoftAssertions();
*
* &#064;Test
* public void soft_bdd_assertions() throws Exception {
* softly.assertThat(1).isEqualTo(2);
* softly.assertThat(Lists.newArrayList(1, 2)).containsOnly(1, 2);
* // no need to call assertAll(), this is done automatically.
* }
* }</code></pre>
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class JUnitSoftAssertions extends org.assertj.core.api.JUnitSoftAssertions {
Expand Down
3 changes: 1 addition & 2 deletions src/test/resources/SoftAssertions.expected.txt
@@ -1,8 +1,7 @@
package org.assertj.assertions.generator.data;

/**
* Entry point for assertions of different data types. Each method in this class is a static factory for the
* type-specific assertion objects.
* Entry point for soft assertions of different data types.
*/
@javax.annotation.Generated(value="assertj-assertions-generator")
public class SoftAssertions extends org.assertj.core.api.SoftAssertions {
Expand Down

0 comments on commit 76d6923

Please sign in to comment.