Correctly deploy artifacts, and fix a few bits of missing javadoc (#7)

Author: FrankHossfeld

gwt-editor-processor/pom.xml

@@ -13,7 +13,6 @@
     <packaging>jar</packaging>
 
     <name>GWT Editor Processor</name>
-<!--    <description></description>-->
     <url>https://github.com/gwtproject/gwt-editor</url>
 
     <organization>
@@ -59,6 +58,8 @@
         <junit.version>4.13</junit.version>
         <org.truth.version>0.23</org.truth.version>
         <truth.version>1.0</truth.version>
+
+        <maven.shade.plugin>3.2.4</maven.shade.plugin>
     </properties>
 
     <dependencies>
@@ -199,6 +200,7 @@
             </plugin>
             <plugin>
                 <artifactId>maven-shade-plugin</artifactId>
+                <version>${maven.shade.plugin}</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -232,6 +234,13 @@
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>flatten-maven-plugin</artifactId>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>false</skip>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 
@@ -287,3 +296,4 @@
         </profile>
     </profiles>
 </project>
+

gwt-editor-processor/src/main/java/org/gwtproject/editor/processor/ModelUtils.java

@@ -89,12 +89,16 @@ public static boolean isValueType(TypeMirror type) {
    * Returns all of the superclasses and superinterfaces for a given type including the type itself.
    * The returned set maintains an internal breadth-first ordering of the type, followed by its
    * interfaces (and their super-interfaces), then the supertype and its interfaces, and so on.
+   *
+   * @param types Utility methods for operating on types
+   * @param typeMirror the type mirror
+   * @return set of type mirrors
    */
-  public static Set<TypeMirror> getFlattenedSupertypeHierarchy(Types types, TypeMirror t) {
+  public static Set<TypeMirror> getFlattenedSupertypeHierarchy(Types types, TypeMirror typeMirror) {
     List<TypeMirror> toAdd = new ArrayList<>();
     LinkedHashSet<TypeMirror> result = new LinkedHashSet<>();
 
-    toAdd.add(t);
+    toAdd.add(typeMirror);
 
     for (int i = 0; i < toAdd.size(); i++) {
       TypeMirror type = toAdd.get(i);

gwt-editor-processor/src/main/java/org/gwtproject/editor/processor/model/BeanMethod.java

@@ -102,7 +102,13 @@ public boolean matches(EditorTypes types, ExecutableElement method) {
   private static final String IS_PREFIX = "is";
   private static final String SET_PREFIX = "set";
 
-  /** Determine which Action a method maps to. */
+  /**
+   * Determine which Action a method maps to.
+   *
+   * @param types editor types
+   * @param method method to execute
+   * @return matching method
+   */
   public static BeanMethod which(EditorTypes types, ExecutableElement method) {
     for (BeanMethod action : BeanMethod.values()) {
       if (action.matches(types, method)) {
@@ -112,7 +118,12 @@ public static BeanMethod which(EditorTypes types, ExecutableElement method) {
     throw new RuntimeException("CALL should have matched");
   }
 
-  /** Infer the name of a property from the method. */
+  /**
+   * Infer the name of a property from the method.
+   *
+   * @param method executable method
+   * @return name of executable method
+   */
   public String inferName(ExecutableElement method) {
     if (this == CALL) {
       throw new UnsupportedOperationException(
@@ -178,6 +189,12 @@ private static boolean deepCompare(EditorTypes types, TypeMirror source, TypeMir
     return true;
   }
 
-  /** Returns {@code true} if the BeanLikeMethod matches the method. */
+  /**
+   * Returns {@code true} if the BeanLikeMethod matches the method.
+   *
+   * @param types editor type
+   * @param method executable element
+   * @return true, if the BeanLikeMethod matches the method
+   */
   public abstract boolean matches(EditorTypes types, ExecutableElement method);
 }

gwt-editor-processor/src/main/java/org/gwtproject/editor/processor/model/EditorProperty.java

@@ -338,12 +338,20 @@ public List<EditorProperty> build(Optional<EditorProperty> parent) {
   private String setterName;
   private String simpleExpression;
 
-  /** Returns a complete expression to retrieve the editor. */
+  /**
+   * Returns a complete expression to retrieve the editor.
+   *
+   * @return expression
+   */
   public String getExpression() {
     return editorExpression;
   }
 
-  /** Returns the complete path of the editor, relative to the root object. */
+  /**
+   * Returns the complete path of the editor, relative to the root object.
+   *
+   * @return path
+   */
   public String getPath() {
     return path;
   }
@@ -408,7 +416,11 @@ public String getSimpleExpression() {
     return simpleExpression;
   }
 
-  /** Gets the path specified by the {@code @Path} annotation or inferred via convention. */
+  /**
+   * Gets the path specified by the {@code @Path} annotation or inferred via convention.
+   *
+   * @return declared path
+   */
   public String getDeclaredPath() {
     return declaredPath;
   }

gwt-editor/pom.xml

@@ -71,6 +71,13 @@
           <moduleName>org.gwtproject.editor.Editor</moduleName>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-deploy-plugin</artifactId>
+        <configuration>
+          <skip>false</skip>
+        </configuration>
+      </plugin>
     </plugins>
   </build>