Small documentation updates.

Signed-off-by: Manoel Campos <[email protected]>

Author: manoelcampos

README.md

@@ -3,7 +3,7 @@
 
 ![](coverage-report-sample.png)
 
-A Doclet to generate JavaDoc coverage reports. It parses the java source files and checks the percentage of the Java code covered by JavaDoc documentation, including:
+The Doclet parses java source files and checks the percentage of the Java code covered by JavaDoc documentation, including:
 - packages (*Java 9 modules not supported yet*)
 - classes, inner classes, interfaces and enums
 - class attributes
@@ -158,11 +158,6 @@ task javadocJar(type: Jar, dependsOn: javadocCoverageReport) {
 }
 ```
 
-The example shows how to ignore the package `com.manoelcampos.sample2` from the coverage report. The `<excludePackageNames>` tag accepts a list of packages separated by `:` and also wildcards such as `*`.
-For more details, check this [link](https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html).
-
-If you are generating the regular JavaDoc HTML files, you have to include this configuration only where the CoverageDoclet is being used into your pom.xml, unless you want these packages to be excluded from the regular JavaDocs too.
-
 # Additional Configuration (optional)
 
 You can define additional configurations for the plugin. 
@@ -190,6 +185,11 @@ You can exclude some packages from the coverage report by adding the code exampl
 </configuration>
 ```
 
+The example shows how to ignore the package `com.manoelcampos.sample2` from the coverage report. The `<excludePackageNames>` tag accepts a list of packages separated by `:` and also wildcards such as `*`.
+For more details, check this [link](https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html).
+
+If you are generating the regular JavaDoc HTML files, you have to include this configuration only where the CoverageDoclet is being used into your pom.xml, unless you want these packages to be excluded from the regular JavaDocs too.
+
 # Building the Doclet from Sources
 
 The Doclet is a Java Maven project which can be built directly from any IDE or using the following maven command:

sample-project/pom.xml

@@ -60,6 +60,12 @@
                                 <version>1.2.0</version>
                             </docletArtifact>
                             <failOnError>false</failOnError>
+
+                            <!-- The following configuration is optional.
+                             If an output name isn't given, the report will be
+                             generated as index.html.
+                             -->
+                            <additionalOptions>-outputName "relatorio.html"</additionalOptions>
                         </configuration>
                     </execution>
                 </executions>

src/main/java/com/manoelcampos/javadoc/coverage/Utils.java

@@ -34,10 +34,13 @@ public final class Utils {
     private Utils() {}
 
     /**
-     * Checks if a element (class, interface, method, etc) is in fact documented or not.
+     * Checks if an element (package, class, interface, method or constructor) is in fact documented or not.
      * Sometimes, there is a javadoc, but the description of the member is empty.
      * The javadoc may just contain tags documenting the elements belonging to this member
-     * (such as method parameters).
+     * (such as method parameters), but the member itself is not documented.
+     *
+     * <p><b>WARNING</b>: This method is not useful to check if a {@code @param}, {@code @return} or {@code @throws} tag
+     * for a method is documented or not.</p>
      *
      * @param javadoc the complete JavaDoc for an element.
      * @return

src/main/java/com/manoelcampos/javadoc/coverage/stats/MethodTagsDocStats.java

@@ -86,7 +86,7 @@ protected ExecutableMemberDoc getDoc() {
      * A set of tags doesn't have documentation.
      * Only each individual tag may have.
      *
-     * @return
+     * @return always false
      */
     @Override
     public boolean isDocumented() {