Repository: camel
Updated Branches:
  refs/heads/master 5d5c0a2ed -> bd3218774


CAMEL-7999: apt compiler to better grab javadoc from builder pattern for the 
json schema documentation.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4a4188e1
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4a4188e1
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4a4188e1

Branch: refs/heads/master
Commit: 4a4188e10bff1af694d5339b1dfa04bdb921db80
Parents: 5d5c0a2
Author: Claus Ibsen <[email protected]>
Authored: Mon Jan 19 11:06:02 2015 +0100
Committer: Claus Ibsen <[email protected]>
Committed: Mon Jan 19 11:06:02 2015 +0100

----------------------------------------------------------------------
 .../tools/apt/AbstractAnnotationProcessor.java  | 17 ++++++++-
 .../camel/tools/apt/EipAnnotationProcessor.java | 40 ++++++++++----------
 .../tools/apt/EndpointAnnotationProcessor.java  |  4 +-
 3 files changed, 37 insertions(+), 24 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/4a4188e1/tooling/apt/src/main/java/org/apache/camel/tools/apt/AbstractAnnotationProcessor.java
----------------------------------------------------------------------
diff --git 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/AbstractAnnotationProcessor.java
 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/AbstractAnnotationProcessor.java
index 66df71a..8a9f72d 100644
--- 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/AbstractAnnotationProcessor.java
+++ 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/AbstractAnnotationProcessor.java
@@ -49,7 +49,7 @@ import static 
org.apache.camel.tools.apt.Strings.isNullOrEmpty;
  */
 public abstract class AbstractAnnotationProcessor extends AbstractProcessor {
 
-    protected String findJavaDoc(Elements elementUtils, Element element, 
String fieldName, TypeElement classElement, boolean builderPattern) {
+    protected String findJavaDoc(Elements elementUtils, Element element, 
String fieldName, String name, TypeElement classElement, boolean 
builderPattern) {
         String answer = null;
         if (element != null) {
             answer = elementUtils.getDocComment(element);
@@ -98,8 +98,21 @@ public abstract class AbstractAnnotationProcessor extends 
AbstractProcessor {
 
             // lets try builder pattern
             if (answer == null && builderPattern) {
-                // lets find the getter
                 methods = 
ElementFilter.methodsIn(classElement.getEnclosedElements());
+                // lets try the builder pattern using annotation name 
(optional) as the method name
+                if (name != null) {
+                    for (ExecutableElement method : methods) {
+                        String methodName = method.getSimpleName().toString();
+                        if (name.equals(methodName) && 
method.getParameters().size() == 1) {
+                            String doc = elementUtils.getDocComment(method);
+                            if (!isNullOrEmpty(doc)) {
+                                answer = doc;
+                                break;
+                            }
+                        }
+                    }
+                }
+                // lets try builder pattern using fieldName as the method name
                 for (ExecutableElement method : methods) {
                     String methodName = method.getSimpleName().toString();
                     if (fieldName.equals(methodName) && 
method.getParameters().size() == 1) {

http://git-wip-us.apache.org/repos/asf/camel/blob/4a4188e1/tooling/apt/src/main/java/org/apache/camel/tools/apt/EipAnnotationProcessor.java
----------------------------------------------------------------------
diff --git 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EipAnnotationProcessor.java
 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EipAnnotationProcessor.java
index eda4bcb..4414f87 100644
--- 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EipAnnotationProcessor.java
+++ 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EipAnnotationProcessor.java
@@ -294,7 +294,7 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         String fieldTypeName = fieldType.toString();
         TypeElement fieldTypeElement = findTypeElement(roundEnv, 
fieldTypeName);
 
-        String docComment = findJavaDoc(elementUtils, fieldElement, fieldName, 
classElement, true);
+        String docComment = findJavaDoc(elementUtils, fieldElement, fieldName, 
name, classElement, true);
         boolean required = attribute.required();
 
         // gather enums
@@ -337,7 +337,7 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
             String fieldTypeName = fieldType.toString();
             TypeElement fieldTypeElement = findTypeElement(roundEnv, 
fieldTypeName);
 
-            String docComment = findJavaDoc(elementUtils, fieldElement, 
fieldName, classElement, true);
+            String docComment = findJavaDoc(elementUtils, fieldElement, 
fieldName, name, classElement, true);
             boolean required = element.required();
 
             // gather enums
@@ -396,7 +396,7 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
             TypeMirror fieldType = fieldElement.asType();
             String fieldTypeName = fieldType.toString();
 
-            String docComment = findJavaDoc(elementUtils, fieldElement, 
fieldName, classElement, true);
+            String docComment = findJavaDoc(elementUtils, fieldElement, 
fieldName, name, classElement, true);
             boolean required = true;
 
             // gather oneOf of the elements
@@ -417,52 +417,52 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         Elements elementUtils = processingEnv.getElementUtils();
 
         // group
-        String docComment = findJavaDoc(elementUtils, null, "group", 
classElement, true);
+        String docComment = findJavaDoc(elementUtils, null, "group", null, 
classElement, true);
         EipOption ep = new EipOption("group", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // group
-        docComment = findJavaDoc(elementUtils, null, "streamCache", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "streamCache", null, 
classElement, true);
         ep = new EipOption("streamCache", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // trace
-        docComment = findJavaDoc(elementUtils, null, "trace", classElement, 
true);
+        docComment = findJavaDoc(elementUtils, null, "trace", null, 
classElement, true);
         ep = new EipOption("trace", "attribute", "java.lang.String", false, 
"", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // trace
-        docComment = findJavaDoc(elementUtils, null, "messageHistory", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "messageHistory", null, 
classElement, true);
         ep = new EipOption("messageHistory", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // trace
-        docComment = findJavaDoc(elementUtils, null, "handleFault", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "handleFault", null, 
classElement, true);
         ep = new EipOption("handleFault", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // delayer
-        docComment = findJavaDoc(elementUtils, null, "delayer", classElement, 
true);
+        docComment = findJavaDoc(elementUtils, null, "delayer", null, 
classElement, true);
         ep = new EipOption("delayer", "attribute", "java.lang.String", false, 
"", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // autoStartup
-        docComment = findJavaDoc(elementUtils, null, "autoStartup", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "autoStartup", null, 
classElement, true);
         ep = new EipOption("autoStartup", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // startupOrder
-        docComment = findJavaDoc(elementUtils, null, "startupOrder", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "startupOrder", null, 
classElement, true);
         ep = new EipOption("startupOrder", "attribute", "java.lang.Integer", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // errorHandlerRef
-        docComment = findJavaDoc(elementUtils, null, "errorHandlerRef", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "errorHandlerRef", null, 
classElement, true);
         ep = new EipOption("errorHandlerRef", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // routePolicyRef
-        docComment = findJavaDoc(elementUtils, null, "routePolicyRef", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "routePolicyRef", null, 
classElement, true);
         ep = new EipOption("routePolicyRef", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
@@ -470,7 +470,7 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         Set<String> enums = new LinkedHashSet<String>();
         enums.add("Default");
         enums.add("Defer");
-        docComment = findJavaDoc(elementUtils, null, "shutdownRoute", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "shutdownRoute", null, 
classElement, true);
         ep = new EipOption("shutdownRoute", "attribute", 
"org.apache.camel.ShutdownRoute", false, "", docComment, false, true, enums, 
false, null);
         eipOptions.add(ep);
 
@@ -478,14 +478,14 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         enums = new LinkedHashSet<String>();
         enums.add("CompleteCurrentTaskOnly");
         enums.add("CompleteAllTasks");
-        docComment = findJavaDoc(elementUtils, null, "shutdownRunningTask", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "shutdownRunningTask", 
null, classElement, true);
         ep = new EipOption("shutdownRunningTask", "attribute", 
"org.apache.camel.ShutdownRunningTask", false, "", docComment, false, true, 
enums, false, null);
         eipOptions.add(ep);
 
         // inputs
         Set<String> oneOfTypes = new TreeSet<String>();
         oneOfTypes.add("from");
-        docComment = findJavaDoc(elementUtils, null, "inputs", classElement, 
true);
+        docComment = findJavaDoc(elementUtils, null, "inputs", null, 
classElement, true);
         ep = new EipOption("inputs", "element", 
"java.util.List<org.apache.camel.model.FromDefinition>", true, "", docComment, 
false, false, null, true, oneOfTypes);
         eipOptions.add(ep);
 
@@ -510,7 +510,7 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         // remove some types which are not intended as an output in eips
         oneOfTypes.remove("route");
 
-        docComment = findJavaDoc(elementUtils, null, "outputs", classElement, 
true);
+        docComment = findJavaDoc(elementUtils, null, "outputs", null, 
classElement, true);
         ep = new EipOption("outputs", "element", 
"java.util.List<org.apache.camel.model.ProcessorDefinition<?>>", true, "", 
docComment, false, false, null, true, oneOfTypes);
         eipOptions.add(ep);
     }
@@ -524,19 +524,19 @@ public class EipAnnotationProcessor extends 
AbstractAnnotationProcessor {
         Elements elementUtils = processingEnv.getElementUtils();
 
         // id
-        String docComment = findJavaDoc(elementUtils, null, "id", 
classElement, true);
+        String docComment = findJavaDoc(elementUtils, null, "id", null, 
classElement, true);
         EipOption ep = new EipOption("id", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
         eipOptions.add(ep);
 
         // description
-        docComment = findJavaDoc(elementUtils, null, "description", 
classElement, true);
+        docComment = findJavaDoc(elementUtils, null, "description", null, 
classElement, true);
         ep = new EipOption("description", "element", 
"org.apache.camel.model.DescriptionDefinition", false, "", docComment, false, 
false, null, false, null);
         eipOptions.add(ep);
 
         // lets skip custom id as it has no value for end users to configure
         if (!skipUnwanted) {
             // custom id
-            docComment = findJavaDoc(elementUtils, null, "customId", 
classElement, true);
+            docComment = findJavaDoc(elementUtils, null, "customId", null, 
classElement, true);
             ep = new EipOption("customId", "attribute", "java.lang.String", 
false, "", docComment, false, false, null, false, null);
             eipOptions.add(ep);
         }

http://git-wip-us.apache.org/repos/asf/camel/blob/4a4188e1/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
----------------------------------------------------------------------
diff --git 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
index 1af9fe6..39b4156 100644
--- 
a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
+++ 
b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java
@@ -346,7 +346,7 @@ public class EndpointAnnotationProcessor extends 
AbstractAnnotationProcessor {
                     String fieldTypeName = fieldType.toString();
                     TypeElement fieldTypeElement = findTypeElement(roundEnv, 
fieldTypeName);
 
-                    String docComment = findJavaDoc(elementUtils, 
fieldElement, fieldName, classElement, false);
+                    String docComment = findJavaDoc(elementUtils, 
fieldElement, fieldName, name, classElement, false);
                     if (isNullOrEmpty(docComment)) {
                         docComment = path.description();
                     }
@@ -398,7 +398,7 @@ public class EndpointAnnotationProcessor extends 
AbstractAnnotationProcessor {
                         }
                         findClassProperties(writer, roundEnv, endpointPaths, 
endpointOptions, fieldTypeElement, nestedPrefix);
                     } else {
-                        String docComment = findJavaDoc(elementUtils, 
fieldElement, fieldName, classElement, false);
+                        String docComment = findJavaDoc(elementUtils, 
fieldElement, fieldName, name, classElement, false);
                         if (isNullOrEmpty(docComment)) {
                             docComment = param.description();
                         }

Reply via email to