From 62345245e994c35cb37d55502fc0313bc2a189d4 Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Sun, 20 Jul 2014 04:37:40 +0000 Subject: [PATCH] Use the more modern, compact, and flexible Javadoc "{@code ...}" instead of the HTML "...". git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1612019 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/commons/csv/CSVFormat.java | 26 +++++++++---------- .../org/apache/commons/csv/CSVParser.java | 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 95167c30..6bb2fc54 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -233,7 +233,7 @@ public final class CSVFormat implements Serializable { .withIgnoreSurroundingSpaces(true); /** - * Default MySQL format used by the SELECT INTO OUTFILE and LOAD DATA INFILE operations. + * Default MySQL format used by the {@code SELECT INTO OUTFILE} and {@code LOAD DATA INFILE} operations. * *

* This is a tab-delimited format with a LF character as the line separator. Values are not quoted and special characters @@ -320,9 +320,9 @@ public final class CSVFormat implements Serializable { * @param escape * the Character used to escape special characters in values, may be {@code null} to disable * @param ignoreSurroundingSpaces - * true when whitespaces enclosing values should be ignored + * {@code true} when whitespaces enclosing values should be ignored * @param ignoreEmptyLines - * true when the parser should skip empty lines + * {@code true} when the parser should skip empty lines * @param recordSeparator * the line separator to use for output * @param nullString @@ -494,7 +494,7 @@ public final class CSVFormat implements Serializable { /** * Specifies whether empty headers are ignored when parsing the header line. * - * @return true if headers are ignored when parsing the header line, false to throw an + * @return {@code true} if headers are ignored when parsing the header line, {@code false} to throw an * {@link IllegalArgumentException}. */ public boolean isIgnoringEmptyHeaders() { @@ -504,7 +504,7 @@ public final class CSVFormat implements Serializable { /** * Specifies whether empty lines between records are ignored when parsing input. * - * @return true if empty lines between records are ignored, false if they are turned into empty + * @return {@code true} if empty lines between records are ignored, {@code false} if they are turned into empty * records. */ public boolean isIgnoringEmptyLines() { @@ -514,7 +514,7 @@ public final class CSVFormat implements Serializable { /** * Specifies whether spaces around values are ignored when parsing input. * - * @return true if spaces around values are ignored, false if they are treated as part of the + * @return {@code true} if spaces around values are ignored, {@code false} if they are treated as part of the * value. */ public boolean isIgnoringSurroundingSpaces() { @@ -599,7 +599,7 @@ public final class CSVFormat implements Serializable { * * Note that the comment introducer character is only recognized at the start of a line. * - * @return true is comments are supported, false otherwise + * @return {@code true} is comments are supported, {@code false} otherwise */ public boolean isCommentingEnabled() { return commentStart != null; @@ -836,7 +836,7 @@ public final class CSVFormat implements Serializable { * CSVFormat format = aformat.withHeader("name", "email", "phone"); * * @param header - * the header, null if disabled, empty if parsed automatically, user specified otherwise. + * the header, {@code null} if disabled, empty if parsed automatically, user specified otherwise. * * @return A new CSVFormat that is equal to this but with the specified header * @see #withSkipHeaderRecord(boolean) @@ -851,8 +851,8 @@ public final class CSVFormat implements Serializable { * Sets the empty header behavior of the format. * * @param ignoreEmptyHeaders - * the empty header behavior, true to ignore empty headers in the header line, - * false to cause an {@link IllegalArgumentException} to be thrown. + * the empty header behavior, {@code true} to ignore empty headers in the header line, + * {@code false} to cause an {@link IllegalArgumentException} to be thrown. * @return A new CSVFormat that is equal to this but with the specified empty header behavior. */ public CSVFormat withIgnoreEmptyHeaders(final boolean ignoreEmptyHeaders) { @@ -865,8 +865,8 @@ public final class CSVFormat implements Serializable { * Sets the empty line skipping behavior of the format. * * @param ignoreEmptyLines - * the empty line skipping behavior, true to ignore the empty lines between the records, - * false to translate empty lines to empty records. + * the empty line skipping behavior, {@code true} to ignore the empty lines between the records, + * {@code false} to translate empty lines to empty records. * @return A new CSVFormat that is equal to this but with the specified empty line skipping behavior. */ public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) { @@ -879,7 +879,7 @@ public final class CSVFormat implements Serializable { * Sets the trimming behavior of the format. * * @param ignoreSurroundingSpaces - * the trimming behavior, true to remove the surrounding spaces, false to leave the + * the trimming behavior, {@code true} to remove the surrounding spaces, {@code false} to leave the * spaces as is. * @return A new CSVFormat that is equal to this but with the specified trimming behavior. */ diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index 1832c1d8..f7eb4159 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -439,7 +439,7 @@ public final class CSVParser implements Iterable, Closeable { /** * Parses the next record from the current point in the stream. * - * @return the record as an array of values, or null if the end of the stream has been reached + * @return the record as an array of values, or {@code null} if the end of the stream has been reached * @throws IOException * on parse error or input read-failure */