Skip to content

Commit ebba2cd

Browse files
committed
Code refactoring - fixed javadoc errors
1 parent 073c420 commit ebba2cd

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

src/main/java/net/andreinc/mockneat/abstraction/MockConstValue.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ private MockConstValue(T value) {
2727
/**
2828
* <p>Creates a new "constant" MockValue by wrapping an Object value.</p>
2929
*
30+
* @param <T> Generic type for the constant value
3031
* @param value The Object wrapped by the {@code MockConstantValue} class.
3132
* @return A new MockConstValue.
3233
*/

src/main/java/net/andreinc/mockneat/abstraction/MockUnitValue.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ private MockUnitValue(MockUnit<T> mockUnit) {
2828
/**
2929
* Wraps a {@code MockUnit}.
3030
* @param unit The {@code MockUnit} to be wrapped.
31+
* @param <T> generic param for the MockUnit
3132
* @return A new {@code MockUnitValue}
3233
*/
3334
public static <T> MockUnitValue<T> unit(MockUnit<T> unit) {

src/main/java/net/andreinc/mockneat/unit/objects/Reflect.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ public Reflect<T> field(String fieldName, Object value) {
129129
/**
130130
* <p>If the field is not specified, you can enable the library to use default values for a limited range of common types:</p>
131131
*
132-
* <p>
133132
* <ul>
134133
* <li>{@code Boolean}/{@code boolean} - the default value is either {@code true} or {@code false}</li>
135134
* <li>{@code Character}/{@code char} - the default value is an arbitrary letter.</li>
@@ -139,7 +138,6 @@ public Reflect<T> field(String fieldName, Object value) {
139138
* <li>{@code Short}/{@code short} - the default value is a short number in the [0, 100) range</li>
140139
* <li>{@code String} - a random string with a size of 32</li>
141140
* </ul>
142-
* </p>
143141
*
144142
* <p>By default the defaults are disabled</p>
145143
*

src/main/java/net/andreinc/mockneat/unit/objects/Shufflers.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ public static Shufflers shufflers() {
2020
protected Shufflers() {}
2121

2222
/**
23-
* <p>Returns a {@code Shufflers} object than gets the arbitrary permutations of the source.<p>
23+
* <p>Returns a {@code Shufflers} object than gets the arbitrary permutations of the source.</p>
2424
*
25-
* @return A re-usable {@code Shufflers} object.
25+
* @param mockNeat a MockNeat instance
2626
*/
2727
public Shufflers(MockNeat mockNeat) {
2828
super(mockNeat);

src/main/java/net/andreinc/mockneat/unit/seq/Seq.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ public Seq<T> cycle(boolean value) {
112112
}
113113

114114
/**
115-
* <p>If {@link #cycle(boolean)} is not enabled, the {@param after} is the default value generated by the sequence.</p>
115+
* <p>If {@link #cycle(boolean)} is not enabled, the @param after is the default value generated by the sequence.</p>
116116
*
117117
* @param after The default value after Sequence it's generated.
118118
* @return The same {@code Seq<T>} object.

src/main/java/net/andreinc/mockneat/unit/text/SQLInserts.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class SQLInserts extends MockUnitBase implements MockUnit<SQLInsert> {
2424
/**
2525
* <p>Returns a {@code SQLInserts} object that can be used to generate SQL Inserts</p>
2626
*
27-
* @return A re-usable {@code SQLInserts} object. This class implements {@code MockUnit<SQLInsert>}.
27+
* @return A new {@code SQLInserts} object
2828
*/
2929
public static SQLInserts sqlInserts() {
3030
return MockNeat.threadLocal().sqlInserts();
@@ -67,12 +67,12 @@ public SQLInserts column(String column, MockUnit<?> mockUnit) {
6767
/**
6868
* <p>Associates a column of the SQL table with a corresponding {@code MockUnit<T>}. </p>
6969
*
70-
* <p>Before the value is generated from the {@code MockUnit<T>} the {@param sqlParameter} function is applied to the values. This is useful when for example Strings have to be escaped for a given SQL dialect.</p>
70+
* <p>Before the value is generated from the {@code MockUnit<T>} the @param sqlParameter function is applied to the values. This is useful when for example Strings have to be escaped for a given SQL dialect.</p>
7171
*
7272
* @param column The column of the table
7373
* @param mockUnit The {@code MockUnit<T>} used to generate values for the column. The result is automatically transformed to String.
7474
* @param sqlFormatter The {@code Function<String, String>} for formatting the generated value
75-
* @return
75+
* @return The same {@code SQLInserts} instance.
7676
*/
7777
public SQLInserts column(String column, MockUnit<?> mockUnit, Function<String, String> sqlFormatter) {
7878
notEmpty(column, "column");
@@ -100,7 +100,7 @@ public SQLInserts column(String column, String str) {
100100
/**
101101
* <p>Associates a column of the SQL table with a constant value.</p>
102102
*
103-
* <p>Before the value is generated from the {@code MockUnit<T>} the {@param sqlParameter} function is applied to the values. This is useful when for example Strings have to be escaped for a given SQL dialect.</p>
103+
* <p>Before the value is generated from the {@code MockUnit<T>} the @param sqlParameter function is applied to the values. This is useful when for example Strings have to be escaped for a given SQL dialect.</p>
104104
*
105105
* @param column The column of the SQLTable
106106
* @param str The constant {@code String} value.

0 commit comments

Comments
 (0)