javadoc update

Author: osiegmar

lib/src/main/java/de/siegmar/fastcsv/reader/AbstractBaseCsvCallbackHandler.java

@@ -27,23 +27,17 @@ protected long getStartingLineNumber() {
         return startingLineNumber;
     }
 
-    /// Returns whether the current record is a comment.
-    ///
-    /// @return `true` if the current record is a comment
+    /// {@return whether the current record is a comment.}
     protected boolean isComment() {
         return comment;
     }
 
-    /// Returns whether the current record is an empty line.
-    ///
-    /// @return `true` if the current record is an empty line
+    /// {@return whether the current record is an empty line.}
     protected boolean isEmptyLine() {
         return emptyLine;
     }
 
-    /// Returns the number of fields in the current record.
-    ///
-    /// @return the number of fields in the current record
+    /// {@return the number of fields in the current record.}
     protected int getFieldCount() {
         return fieldCount;
     }

lib/src/main/java/de/siegmar/fastcsv/reader/CsvReader.java

@@ -145,15 +145,14 @@ public int skipLines(final Predicate<String> predicate, final int maxLines) {
             "No matching line found within the maximum limit of %d lines.", maxLines));
     }
 
-    /// Returns an iterator over elements of type [CsvRecord].
+    /// {@return an iterator over elements of type [CsvRecord].}
     ///
     /// The returned iterator is not thread-safe.
     /// Remember to close the returned iterator when you're done.
     /// Alternatively, use [#stream()].
     ///
     /// This method is idempotent and can be called multiple times.
     ///
-    /// @return an iterator over the CSV records.
     /// @throws UncheckedIOException if an I/O error occurs.
     /// @throws CsvParseException    if any other problem occurs when parsing the CSV data.
     /// @see #stream()
@@ -162,7 +161,7 @@ public CloseableIterator<T> iterator() {
         return csvRecordIterator;
     }
 
-    /// Returns a [Spliterator] over elements of type [CsvRecord].
+    /// Constructs a [Spliterator] for splitting and traversing the elements of this reader.
     ///
     /// The returned spliterator is not thread-safe.
     /// Remember to invoke [#close()] when you're done.
@@ -179,7 +178,7 @@ public Spliterator<T> spliterator() {
         return new CsvSpliterator();
     }
 
-    /// Returns a new sequential `Stream` with this reader as its source.
+    /// Constructs a new sequential `Stream` with this reader as its source.
     ///
     /// The returned stream is not thread-safe.
     /// Remember to close the returned stream when you're done.

lib/src/main/java/de/siegmar/fastcsv/reader/RecordWrapper.java

@@ -36,36 +36,28 @@ public final class RecordWrapper<T> {
         this.wrappedRecord = wrappedRecord;
     }
 
-    /// Returns whether the record denotes a comment.
+    /// {@return whether the record denotes a comment.}
     ///
     /// This method is only used if the [CsvReader] is configured to skip comments.
-    ///
-    /// @return `true` if the record denotes a comment
     public boolean isComment() {
         return comment;
     }
 
-    /// Returns whether the record is empty.
+    /// {@return whether the record is empty.}
     ///
     /// This method is only used if the [CsvReader] is configured to skip empty lines.
-    ///
-    /// @return `true` if the record is empty
     public boolean isEmptyLine() {
         return emptyLine;
     }
 
-    /// Returns the number of fields in the record.
+    /// {@return the number of fields in the record.}
     ///
     /// This method is only used if the [CsvReader] is configured to check the number of fields in each record.
-    ///
-    /// @return the number of fields in the record
     public int getFieldCount() {
         return fieldCount;
     }
 
-    /// Returns the actual record to be returned by the [CsvReader].
-    ///
-    /// @return the actual record to be returned by the [CsvReader], never `null`
+    /// {@return the actual record to be returned by the [CsvReader], never `null`.}
     public T getWrappedRecord() {
         return wrappedRecord;
     }