This is an automated email from the ASF dual-hosted git repository. pottlinger pushed a commit to branch feature/RAT-326 in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
The following commit(s) were added to refs/heads/feature/RAT-326 by this push: new 22e32eaa RAT-326: Fix javadoc warnings and typos 22e32eaa is described below commit 22e32eaa9195ebc33d0cbb73cb29cce9fe3fa448 Author: P. Ottlinger <pottlin...@apache.org> AuthorDate: Sun Nov 12 22:20:58 2023 +0100 RAT-326: Fix javadoc warnings and typos --- apache-rat-core/src/main/java/org/apache/rat/Reporter.java | 8 ++++---- .../src/main/java/org/apache/rat/api/ContentType.java | 2 +- .../src/main/java/org/apache/rat/report/AbstractReport.java | 10 ++++++++++ 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/apache-rat-core/src/main/java/org/apache/rat/Reporter.java b/apache-rat-core/src/main/java/org/apache/rat/Reporter.java index 12ca39e4..2be95fb6 100644 --- a/apache-rat-core/src/main/java/org/apache/rat/Reporter.java +++ b/apache-rat-core/src/main/java/org/apache/rat/Reporter.java @@ -42,9 +42,9 @@ public class Reporter { } /** - * Execut the report. + * Execute the report. * - * @param configuration The report configuration.. + * @param configuration The report configuration. * @return the currently collected numerical statistics. * @throws Exception in case of errors. */ @@ -74,8 +74,8 @@ public class Reporter { /** * Execute the report. - * @param coutputWriter the writer to send output to. - * @param configuration The report configuration.. + * @param outputWriter the writer to send output to. + * @param configuration The report configuration. * @return the currently collected numerical statistics. * @throws IOException in case of I/O errors. * @throws RatException in case of internal errors. diff --git a/apache-rat-core/src/main/java/org/apache/rat/api/ContentType.java b/apache-rat-core/src/main/java/org/apache/rat/api/ContentType.java index 84b4ee3b..d5a2a0cc 100644 --- a/apache-rat-core/src/main/java/org/apache/rat/api/ContentType.java +++ b/apache-rat-core/src/main/java/org/apache/rat/api/ContentType.java @@ -32,7 +32,7 @@ public class ContentType { /** * Constructs content types, - * performing an necessary conversions. + * performing any necessary conversions. * @param mediaType not null * @param subType not null * @param parameters not null diff --git a/apache-rat-core/src/main/java/org/apache/rat/report/AbstractReport.java b/apache-rat-core/src/main/java/org/apache/rat/report/AbstractReport.java index 18bfd1fd..d3d896e9 100644 --- a/apache-rat-core/src/main/java/org/apache/rat/report/AbstractReport.java +++ b/apache-rat-core/src/main/java/org/apache/rat/report/AbstractReport.java @@ -26,14 +26,24 @@ import org.apache.rat.api.RatException; * Abstract base class for deriving implementations of {@link RatReport}. */ public abstract class AbstractReport implements RatReport { + /** + * Empty default implementation. + */ public void startReport() throws RatException { // Does nothing } + /** + * Empty default implementation. + * @param document the actual document + */ public void report(Document document) throws RatException { // Does nothing } + /** + * Empty default implementation. + */ public void endReport() throws RatException { // Does nothing }