Skip to content

Commit 9be5ba6

Browse files
committed
JavaDoc: Replace line-breaks with paragraph tags
1 parent 69bfbd2 commit 9be5ba6

File tree

4 files changed

+21
-13
lines changed

4 files changed

+21
-13
lines changed

src/main/java/com/nordstrom/common/base/ExceptionUnwrapper.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ private ExceptionUnwrapper() {
1919
}
2020

2121
/**
22-
* Unwrap the specified exception.<br>
23-
* <br>
22+
* Unwrap the specified exception.
23+
* <p>
2424
* <b>NOTE</b>: This method unwraps the exception chain until it encounters either a non-wrapper exception or an
2525
* exception with no specified cause. The unwrapped exception is returned.
2626
*
@@ -32,8 +32,8 @@ public static Throwable unwrap(Throwable throwable) {
3232
}
3333

3434
/**
35-
* Unwrap the specified exception, optionally retaining wrapper messages.<br>
36-
* <br>
35+
* Unwrap the specified exception, optionally retaining wrapper messages.
36+
* <p>
3737
* <b>NOTE</b>: This method unwraps the exception chain until it encounters either a non-wrapper exception or an
3838
* exception with no specified cause. The unwrapped exception is returned.
3939
*

src/main/java/com/nordstrom/common/file/OSInfo.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ public T getType() {
5959
}
6060

6161
/**
62-
* Add the specified mapping to the collection.<br>
62+
* Add the specified mapping to the collection.
63+
* <p>
6364
* <b>NOTE</b>: If a mapping for the specified constant already exists, this mapping will be replaced.
6465
*
6566
* @param <U> an operating system mapping enumeration that implements the {@link OSProps} interface
@@ -72,7 +73,8 @@ public <U extends Enum<U> & OSProps> String put(U typeConst) {
7273
}
7374

7475
/**
75-
* Add the specified mapping to the collection.<br>
76+
* Add the specified mapping to the collection.
77+
* <p>
7678
* <b>NOTE</b>: If a mapping for the specified constant already exists, this mapping will be replaced.
7779
*
7880
* @param <U> an operating system mapping enumeration that implements the {@link OSProps} interface
@@ -86,7 +88,8 @@ public <U extends Enum<U> & OSProps> String put(U typeConst, String pattern) {
8688
}
8789

8890
/**
89-
* Add the mappings defined by the specified enumeration to the collection.<br>
91+
* Add the mappings defined by the specified enumeration to the collection.
92+
* <p>
9093
* <b>NOTE</b>: If any of the specified mappings already exist, the previous mappings will be replaced.
9194
*
9295
* @param <U> an operating system mapping enumeration that implements the {@link OSProps} interface

src/main/java/com/nordstrom/common/file/PathUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* already contains at least one file that matches the specified base name and extension, the algorithm used to select
2424
* the next path will always return a path whose index is one more than the highest index that currently exists. (If a
2525
* single file with no index is found, its implied index is 0.)
26-
* <br><br>
26+
* <p>
2727
* <b>Example usage of {@code getNextPath}</b>
2828
* <pre>
2929
* ...

src/main/java/com/nordstrom/common/jdbc/DatabaseUtils.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,8 @@ public static ResultPackage getResultPackage(QueryAPI query, Object... queryArgs
171171
* @param resultType desired result type (see TYPES above)
172172
* @param query query object to execute
173173
* @param queryArgs replacement values for query place-holders
174-
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type<br>
174+
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type
175+
* <p>
175176
* <b>NOTE</b>: If you specify {@link ResultPackage} as the result type, it's recommended that you close this object
176177
* when you're done with it to free up database and JDBC resources that were allocated for it.
177178
*/
@@ -210,7 +211,8 @@ private static <T> T executeQuery(Class<T> resultType, QueryAPI query, Object...
210211
* @param connectionStr database connection string
211212
* @param queryStr a SQL statement that may contain one or more '?' IN parameter placeholders
212213
* @param params an array of objects containing the input parameter values
213-
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type<br>
214+
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type
215+
* <p>
214216
* <b>NOTE</b>: If you specify {@link ResultPackage} as the result type, it's recommended that you close this object
215217
* when you're done with it to free up database and JDBC resources that were allocated for it.
216218
*/
@@ -311,7 +313,8 @@ public static ResultPackage getResultPackage(SProcAPI sproc, Object... params) {
311313
* @param resultType desired result type (see TYPES above)
312314
* @param sproc stored procedure object to execute
313315
* @param params an array of objects containing the input parameter values
314-
* @return an object of the indicated type<br>
316+
* @return an object of the indicated type
317+
* <p>
315318
* <b>NOTE</b>: If you specify {@link ResultPackage} as the result type, it's recommended that you close this object
316319
* when you're done with it to free up database and JDBC resources that were allocated for it.
317320
*/
@@ -415,7 +418,8 @@ public static <T> T executeStoredProcedure(Class<T> resultType, SProcAPI sproc,
415418
* @param connectionStr database connection string
416419
* @param sprocName name of the stored procedure to be executed
417420
* @param params an array of objects containing the input parameter values
418-
* @return an object of the indicated type<br>
421+
* @return an object of the indicated type
422+
* <p>
419423
* <b>NOTE</b>: If you specify {@link ResultPackage} as the result type, it's recommended that you close this object
420424
* when you're done with it to free up database and JDBC resources that were allocated for it.
421425
*/
@@ -463,7 +467,8 @@ public static <T> T executeStoredProcedure(Class<T> resultType, String connectio
463467
* @param resultType desired result type (see TYPES above)
464468
* @param connectionStr database connection string
465469
* @param statement prepared statement to be executed (query or store procedure)
466-
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type<br>
470+
* @return for update operations, the number of rows affected; for query operations, an object of the indicated type
471+
* <p>
467472
* <b>NOTE</b>: If you specify {@link ResultPackage} as the result type, it's recommended that you close this object
468473
* when you're done with it to free up database and JDBC resources that were allocated for it.
469474
*/

0 commit comments

Comments
 (0)