You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/12/10 05:21:26 UTC
[commons-csv] branch master updated: Javadoc: Replace
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
The following commit(s) were added to refs/heads/master by this push:
new 18644c8 Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
18644c8 is described below
commit 18644c88d4f063f9727f5826e78245559aef033a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Dec 10 00:21:22 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../java/org/apache/commons/csv/CSVFormat.java | 4 +--
src/main/java/org/apache/commons/csv/IOUtils.java | 32 +++++++++++-----------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 9a93311..b7cf1ba 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -633,7 +633,7 @@ public final class CSVFormat implements Serializable {
* @param c
* the character to check
*
- * @return true if <code>c</code> is a line break character
+ * @return true if {@code c} is a line break character
*/
private static boolean isLineBreak(final char c) {
return c == LF || c == CR;
@@ -645,7 +645,7 @@ public final class CSVFormat implements Serializable {
* @param c
* the character to check, may be null
*
- * @return true if <code>c</code> is a line break character (and not null)
+ * @return true if {@code c} is a line break character (and not null)
*/
private static boolean isLineBreak(final Character c) {
return c != null && isLineBreak(c.charValue());
diff --git a/src/main/java/org/apache/commons/csv/IOUtils.java b/src/main/java/org/apache/commons/csv/IOUtils.java
index e82fb04..1771d4d 100644
--- a/src/main/java/org/apache/commons/csv/IOUtils.java
+++ b/src/main/java/org/apache/commons/csv/IOUtils.java
@@ -42,15 +42,15 @@ class IOUtils {
private static final int EOF = -1;
/**
- * Copies chars from a large (over 2GB) <code>Reader</code> to an <code>Appendable</code>.
+ * Copies chars from a large (over 2GB) {@code Reader} to an {@code Appendable}.
* <p>
* This method buffers the input internally, so there is no need to use a
- * <code>BufferedReader</code>.
+ * {@code BufferedReader}.
* </p>
* The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
*
- * @param input the <code>Reader</code> to read from
- * @param output the <code>Appendable</code> to append to
+ * @param input the {@code Reader} to read from
+ * @param output the {@code Appendable} to append to
* @return the number of characters copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
@@ -61,14 +61,14 @@ class IOUtils {
}
/**
- * Copies chars from a large (over 2GB) <code>Reader</code> to an <code>Appendable</code>.
+ * Copies chars from a large (over 2GB) {@code Reader} to an {@code Appendable}.
* <p>
* This method uses the provided buffer, so there is no need to use a
- * <code>BufferedReader</code>.
+ * {@code BufferedReader}.
* </p>
*
- * @param input the <code>Reader</code> to read from
- * @param output the <code>Appendable</code> to write to
+ * @param input the {@code Reader} to read from
+ * @param output the {@code Appendable} to write to
* @param buffer the buffer to be used for the copy
* @return the number of characters copied
* @throws NullPointerException if the input or output is null
@@ -90,15 +90,15 @@ class IOUtils {
* <p>
* Copied from Apache Commons IO.
* </p>
- * Copies chars from a large (over 2GB) <code>Reader</code> to a <code>Writer</code>.
+ * Copies chars from a large (over 2GB) {@code Reader} to a {@code Writer}.
* <p>
* This method buffers the input internally, so there is no need to use a
- * <code>BufferedReader</code>.
+ * {@code BufferedReader}.
* <p>
* The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
*
- * @param input the <code>Reader</code> to read from
- * @param output the <code>Writer</code> to write to
+ * @param input the {@code Reader} to read from
+ * @param output the {@code Writer} to write to
* @return the number of characters copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
@@ -112,14 +112,14 @@ class IOUtils {
* <p>
* Copied from Apache Commons IO.
* </p>
- * Copies chars from a large (over 2GB) <code>Reader</code> to a <code>Writer</code>.
+ * Copies chars from a large (over 2GB) {@code Reader} to a {@code Writer}.
* <p>
* This method uses the provided buffer, so there is no need to use a
- * <code>BufferedReader</code>.
+ * {@code BufferedReader}.
* <p>
*
- * @param input the <code>Reader</code> to read from
- * @param output the <code>Writer</code> to write to
+ * @param input the {@code Reader} to read from
+ * @param output the {@code Writer} to write to
* @param buffer the buffer to be used for the copy
* @return the number of characters copied
* @throws NullPointerException if the input or output is null