Skip to content

Commit 57ab198

Browse files
committed
Normalize first word of Javadocs
- "getFoo" methods "Gets foo" - "isFoo" methods "Tests foo"
1 parent c04fc6c commit 57ab198

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

src/main/java/org/apache/commons/csv/CSVFormat.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1511,7 +1511,7 @@ public char getDelimiter() {
15111511
}
15121512

15131513
/**
1514-
* Returns the character delimiting the values (typically ";", "," or "\t").
1514+
* Gets the character delimiting the values (typically ";", "," or "\t").
15151515
*
15161516
* @return the delimiter.
15171517
* @since 1.9.0
@@ -1531,7 +1531,7 @@ public DuplicateHeaderMode getDuplicateHeaderMode() {
15311531
}
15321532

15331533
/**
1534-
* Returns the escape character.
1534+
* Gets the escape character.
15351535
*
15361536
* @return the escape character, may be {@code null}
15371537
*/
@@ -1540,7 +1540,7 @@ public Character getEscapeCharacter() {
15401540
}
15411541

15421542
/**
1543-
* Returns a copy of the header array.
1543+
* Gets a copy of the header array.
15441544
*
15451545
* @return a copy of the header array; {@code null} if disabled, the empty array if to be read from the file
15461546
*/
@@ -1549,7 +1549,7 @@ public String[] getHeader() {
15491549
}
15501550

15511551
/**
1552-
* Returns a copy of the header comment array.
1552+
* Gets a copy of the header comment array.
15531553
*
15541554
* @return a copy of the header comment array; {@code null} if disabled.
15551555
*/
@@ -1599,7 +1599,7 @@ public String getNullString() {
15991599
}
16001600

16011601
/**
1602-
* Returns the character used to encapsulate values containing special characters.
1602+
* Gets the character used to encapsulate values containing special characters.
16031603
*
16041604
* @return the quoteChar character, may be {@code null}
16051605
*/
@@ -1608,7 +1608,7 @@ public Character getQuoteCharacter() {
16081608
}
16091609

16101610
/**
1611-
* Returns the quote policy output fields.
1611+
* Gets the quote policy output fields.
16121612
*
16131613
* @return the quote policy
16141614
*/
@@ -1617,7 +1617,7 @@ public QuoteMode getQuoteMode() {
16171617
}
16181618

16191619
/**
1620-
* Returns the record separator delimiting output records.
1620+
* Gets the record separator delimiting output records.
16211621
*
16221622
* @return the record separator
16231623
*/
@@ -1626,7 +1626,7 @@ public String getRecordSeparator() {
16261626
}
16271627

16281628
/**
1629-
* Returns whether to skip the header record.
1629+
* Gets whether to skip the header record.
16301630
*
16311631
* @return whether to skip the header record.
16321632
*/
@@ -1635,7 +1635,7 @@ public boolean getSkipHeaderRecord() {
16351635
}
16361636

16371637
/**
1638-
* Returns whether to add a trailing delimiter.
1638+
* Gets whether to add a trailing delimiter.
16391639
*
16401640
* @return whether to add a trailing delimiter.
16411641
* @since 1.3
@@ -1645,7 +1645,7 @@ public boolean getTrailingDelimiter() {
16451645
}
16461646

16471647
/**
1648-
* Returns whether to trim leading and trailing blanks. This is used by {@link #print(Object, Appendable, boolean)} Also by
1648+
* Gets whether to trim leading and trailing blanks. This is used by {@link #print(Object, Appendable, boolean)} Also by
16491649
* {CSVParser#addRecordValue(boolean)}
16501650
*
16511651
* @return whether to trim leading and trailing blanks.
@@ -1708,7 +1708,7 @@ private boolean isDelimiter(final char ch, final CharSequence charSeq, final int
17081708
}
17091709

17101710
/**
1711-
* Returns whether escape are being processed.
1711+
* Tests whether escape are being processed.
17121712
*
17131713
* @return {@code true} if escapes are processed
17141714
*/
@@ -1717,7 +1717,7 @@ public boolean isEscapeCharacterSet() {
17171717
}
17181718

17191719
/**
1720-
* Returns whether a nullString has been defined.
1720+
* Tests whether a nullString has been defined.
17211721
*
17221722
* @return {@code true} if a nullString is defined
17231723
*/
@@ -1726,7 +1726,7 @@ public boolean isNullStringSet() {
17261726
}
17271727

17281728
/**
1729-
* Returns whether a quoteChar has been defined.
1729+
* Tests whether a quoteChar has been defined.
17301730
*
17311731
* @return {@code true} if a quoteChar is defined
17321732
*/

0 commit comments

Comments
 (0)