fixed documentation

Author: Claudenw

apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java

@@ -462,7 +462,7 @@ public void addIncludedMatcher(final DocumentNameMatcher matcher) {
     /**
      * Add file patterns that are to be included. These patterns override any exclusion of
      * the same files.
-     * @param patterns the iterable of Strings containing the patterns.
+     * @param patterns The iterable of Strings containing the patterns.
      */
     public void addIncludedPatterns(final Iterable<String> patterns) {
         exclusionProcessor.addIncludedPatterns(patterns);
@@ -514,7 +514,7 @@ public void setStyleSheet(final IODescriptor<InputStream> styleSheet) {
      * Adds the licenses and approved licenses from the defaults object to the
      * configuration. <em>Side effect:</em> if the report should be styled and no
      * style sheet has been set the plain stylesheet from the defaults will be used.
-     * @param defaults the defaults to set.
+     * @param defaults The defaults to set.
      */
     public void setFrom(final Defaults defaults) {
         licenseSetFactory.add(defaults.getLicenseSetFactory());
@@ -562,7 +562,7 @@ public void setStyleSheet(final URL styleSheet) {
      * times to provide the stream. Suppliers should prepare streams that are
      * appended to and that can be closed. If an {@code OutputStream} should not be
      * closed consider wrapping it in a {@code CloseShieldOutputStream}
-     * @param out the OutputStream supplier that provides the output stream to write
+     * @param out The OutputStream supplier that provides the output stream to write
      * the report to. A null value will use System.out.
      * @see CloseShieldOutputStream
      */
@@ -596,7 +596,7 @@ public void setOut(final File file) {
     /**
      * Returns the output stream supplier. If no stream has been set returns a
      * supplier for System.out.
-     * @return the supplier of the output stream to write the report to.
+     * @return The supplier of the output stream to write the report to.
      */
     public IOSupplier<OutputStream> getOutput() {
         return getOutputDescriptor().ioSupplier();
@@ -613,7 +613,7 @@ public IODescriptor<OutputStream> getOutputDescriptor() {
 
     /**
      * Gets a PrintWriter that wraps the output stream.
-     * @return a supplier for a PrintWriter that wraps the output stream.
+     * @return A supplier for a PrintWriter that wraps the output stream.
      * @see #getOutput()
      */
     public IOSupplier<PrintWriter> getWriter() {
@@ -623,7 +623,7 @@ public IOSupplier<PrintWriter> getWriter() {
     /**
      * Adds a license to the list of licenses. Does not add the license to the list
      * of approved licenses.
-     * @param license the license to add to the list of licenses.
+     * @param license The license to add to the list of licenses.
      */
     public void addLicense(final ILicense license) {
         licenseSetFactory.addLicense(license);
@@ -632,7 +632,7 @@ public void addLicense(final ILicense license) {
     /**
      * Adds a license to the list of licenses. Does not add the license to the list
      * of approved licenses.
-     * @param builder the license builder to build and add to the list of licenses.
+     * @param builder The license builder to build and add to the list of licenses.
      * @return The ILicense implementation that was added.
      */
     public ILicense addLicense(final ILicense.Builder builder) {
@@ -642,7 +642,7 @@ public ILicense addLicense(final ILicense.Builder builder) {
     /**
      * Adds multiple licenses to the list of licenses. Does not add the licenses to
      * the list of approved licenses.
-     * @param licenses the licenses to add.
+     * @param licenses The licenses to add.
      */
     public void addLicenses(final Collection<ILicense> licenses) {
         licenseSetFactory.addLicenses(licenses);
@@ -651,7 +651,7 @@ public void addLicenses(final Collection<ILicense> licenses) {
     /**
      * Adds a license family to the list of families. Does not add the family to the
      * list of approved licenses.
-     * @param family the license family to add to the list of license families.
+     * @param family The license family to add to the list of license families.
      */
     public void addFamily(final ILicenseFamily family) {
        licenseSetFactory.addFamily(family);
@@ -660,7 +660,7 @@ public void addFamily(final ILicenseFamily family) {
     /**
      * Adds a license family to the list of families. Does not add the family to the
      * list of approved licenses.
-     * @param builder the licenseFamily.Builder to build and add to the list of
+     * @param builder The licenseFamily.Builder to build and add to the list of
      * licenses.
      */
     public void addFamily(final ILicenseFamily.Builder builder) {
@@ -670,7 +670,7 @@ public void addFamily(final ILicenseFamily.Builder builder) {
     /**
      * Adds multiple families to the list of license families. Does not add the
      * licenses to the list of approved licenses.
-     * @param families the license families to add.
+     * @param families The license families to add.
      */
     public void addFamilies(final Collection<ILicenseFamily> families) {
         families.forEach(this::addApprovedLicenseCategory);
@@ -723,7 +723,7 @@ public void removeApprovedLicenseCategories(final Collection<String> familyCateg
     /**
      * Gets the SortedSet of approved license categories. <em>Once a license has
      * been removed from the approved list it cannot be re-added</em>
-     * @param filter the LicenseFilter to filter the categories by.
+     * @param filter The LicenseFilter to filter the categories by.
      * @return the Sorted set of approved license categories.
      */
     public SortedSet<String> getLicenseCategories(final LicenseFilter filter) {
@@ -733,7 +733,7 @@ public SortedSet<String> getLicenseCategories(final LicenseFilter filter) {
     /**
      * Gets the SortedSet of approved license categories. <em>Once a license has
      * been removed from the approved list it cannot be re-added</em>
-     * @param filter the LicenseFilter to filter the licenses by.
+     * @param filter The LicenseFilter to filter the licenses by.
      * @return the Sorted set of approved license categories.
      */
     public UnmodifiableSortedSet<ILicense> getLicenses(final LicenseFilter filter) {
@@ -743,7 +743,7 @@ public UnmodifiableSortedSet<ILicense> getLicenses(final LicenseFilter filter) {
     /**
      * Gets the SortedSet of approved license categories. <em>Once a license has
      * been removed from the approved list it cannot be re-added</em>
-     * @param filter the LicenseFilter to filter the licenses by.
+     * @param filter The LicenseFilter to filter the licenses by.
      * @return the Sorted set of approved license categories.
      */
     public SortedSet<String> getLicenseIds(final LicenseFilter filter) {