Report parameters on superclasses.

Author: Yaytay

src/main/java/uk/co/spudsoft/params4j/doclet/AbstractAsciiDocOption.java

@@ -21,7 +21,8 @@
 import jdk.javadoc.doclet.Doclet;
 
 /**
- *
+ * Abstract option for configuring a {@link jdk.javadoc.doclet.Doclet}.
+ * 
  * @author njt
  */
 public abstract class AbstractAsciiDocOption implements Doclet.Option {
@@ -31,6 +32,14 @@ public abstract class AbstractAsciiDocOption implements Doclet.Option {
   private final List<String> names;
   private final String parameters;
 
+  /**
+   * Constructor.
+   * 
+   * @param argumentCount The number of arguments, this option will consume.
+   * @param description Description of the argument.
+   * @param name The parameter as it would be specified on the command line (or in addiitonalOptions in the maven plugin).
+   * @param parameters The name of the parameter to the option.
+   */
   public AbstractAsciiDocOption(int argumentCount, String description, String name, String parameters) {
     this.argumentCount = argumentCount;
     this.description = description;

src/main/java/uk/co/spudsoft/params4j/doclet/AsciiDocDocTreeWalker.java

@@ -46,7 +46,6 @@
 public class AsciiDocDocTreeWalker extends DocTreePathScanner<Void, Void> {
 
   private final DocletEnvironment environment;  
-  private final AsciiDocOptions options;
   private final Writer writer;
   private final Reporter reporter;
   private final TreePath path;
@@ -59,7 +58,6 @@ public class AsciiDocDocTreeWalker extends DocTreePathScanner<Void, Void> {
 
   public AsciiDocDocTreeWalker(DocletEnvironment environment, AsciiDocOptions options, Writer writer, Reporter reporter, TreePath path) {
     this.environment = environment;
-    this.options = options;
     this.writer = writer;
     this.reporter = reporter;
     this.path = path;

src/main/java/uk/co/spudsoft/params4j/doclet/AsciiDocDoclet.java

@@ -29,7 +29,11 @@
  *
  * Although additional classes can be provided it will only record setters and/or fields (preferring setters, but falling back to
  * fields).
- *
+ * 
+ * Runs through the specified elements in the {@link jdk.javadoc.doclet.DocletEnvironment} and 
+ * uses an {@link uk.co.spudsoft.params4j.doclet.AsciiDocElementVisitor} to walk through the 
+ * Java {@link javax.lang.model.element.Element}.
+ * 
  * @author njt
  */
 public class AsciiDocDoclet implements Doclet {

src/main/java/uk/co/spudsoft/params4j/doclet/AsciiDocElementVisitor.java

@@ -29,6 +29,7 @@
 import javax.lang.model.element.TypeParameterElement;
 import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.DeclaredType;
+import javax.lang.model.type.TypeMirror;
 import javax.lang.model.util.SimpleTypeVisitor14;
 import javax.tools.Diagnostic;
 import jdk.javadoc.doclet.DocletEnvironment;
@@ -109,6 +110,18 @@ public Void visitType(TypeElement e, Void p) {
 
           e.getEnclosedElements().forEach(enclosed -> enclosed.accept(this, null));
 
+          for (TypeMirror superMirror = e.getSuperclass(); superMirror != null;) {
+
+            Element superElement = environment.getTypeUtils().asElement(superMirror);
+            if (superElement instanceof TypeElement) {
+              TypeElement superTypeElement = (TypeElement) superElement;
+              superTypeElement.getEnclosedElements().forEach(enclosed -> enclosed.accept(this, null));
+              superMirror = superTypeElement.getSuperclass();
+            } else {
+              superMirror = null;
+            }
+          }
+          
           writer.write("|===\n");
         } catch (IOException ex) {
           reporter.print(Diagnostic.Kind.ERROR, "Failed to write to file: " + ex.getMessage());

src/main/java/uk/co/spudsoft/params4j/doclet/AsciiDocOptions.java

@@ -23,6 +23,7 @@
 import jdk.javadoc.doclet.Doclet.Option;
 
 /**
+ * All the options for configuration the {@link uk.co.spudsoft.params4j.doclet.AsciiDocDoclet}.
  *
  * @author njt
  */

src/main/java/uk/co/spudsoft/params4j/doclet/TypeWriter.java

@@ -50,7 +50,6 @@ public class TypeWriter {
 
   public void writeReferenceTree(DocletEnvironment environment, DocTreePath currentPath, ReferenceTree refTree) {
     Element element = environment.getDocTrees().getElement(new DocTreePath(currentPath, refTree));
-    TypeMirror type = environment.getDocTrees().getType(new DocTreePath(currentPath, refTree));
     if (element instanceof ExecutableElement) {      
       TypeElement typeElement = (TypeElement) element.getEnclosingElement();
       ExecutableElement methodElement = (ExecutableElement) element;

src/test/java/uk/co/spudsoft/params4j/doclet/AsciiDocDocletTest.java

@@ -102,7 +102,7 @@ public void testAsciiDoc() throws IOException {
             , "-d"
             , "target/parameter-docs"
             , "--include-classes"
-            , "commentcap.Parameters,commentcap.Credentials"
+            , "commentcap.Parameters,commentcap.Credentials,commentcap.ProtectedCredentials"
             , "--include-classes"
             , "commentcap.DataSource"
             , "-link"

src/test/resources/commentcap/ProtectedCredentials.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (C) 2023 njt
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package commentcap;
+
+/**
+ * Credentials with some protection.
+ * 
+ * @author njt
+ */
+public class ProtectedCredentials extends Credentials {
+  
+  private String protection;
+
+  public String getProtection() {
+    return protection;
+  }
+
+  /**
+   * The protection to apply to the credentials.
+   * @param protection 
+   */
+  public void setProtection(String protection) {
+    this.protection = protection;
+  }
+  
+}