You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2017/04/07 08:47:59 UTC

[3/3] camel git commit: CAMEL-11021: Add missing docs

CAMEL-11021: Add missing docs


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

Branch: refs/heads/master
Commit: 97f442c6dc2f7928a09fcdb8c8c46706d7df067b
Parents: f9d021a
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 7 10:47:44 2017 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 7 10:47:44 2017 +0200

----------------------------------------------------------------------
 .../org/apache/camel/model/RouteDefinition.java | 42 ++++++++++++--------
 .../tools/apt/CoreEipAnnotationProcessor.java   |  7 +++-
 2 files changed, 32 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/97f442c6/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
index 2b4a942..5196da8 100644
--- a/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/RouteDefinition.java
@@ -48,7 +48,6 @@ import org.apache.camel.model.rest.RestBindingDefinition;
 import org.apache.camel.model.rest.RestDefinition;
 import org.apache.camel.processor.interceptor.HandleFault;
 import org.apache.camel.spi.AsEndpointUri;
-import org.apache.camel.spi.Contract;
 import org.apache.camel.spi.LifecycleStrategy;
 import org.apache.camel.spi.Metadata;
 import org.apache.camel.spi.RouteContext;
@@ -664,8 +663,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * at runtime, camel look for a required {@link Transformer} and apply if exists.
      * The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
      * is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}
+     *
+     * @see org.apache.camel.spi.Transformer
+     *
      * @param urn input type URN
      * @return the builder
      */
@@ -682,8 +682,10 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
      * The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
      * is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+     *
+     * @see org.apache.camel.spi.Transformer
+     * @see org.apache.camel.spi.Validator
+     *
      * @param urn input type URN
      * @return the builder
      */
@@ -698,8 +700,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * Declare the expected data type of the input message by Java class.
      * If the actual message type is different at runtime, camel look for a required
      * {@link Transformer} and apply if exists.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}
+     *
+     * @see org.apache.camel.spi.Transformer
+     *
      * @param clazz Class object of the input type
      * @return the builder
      */
@@ -714,8 +717,10 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * Declare the expected data type of the input message by Java class with content validation enabled.
      * If the actual message type is different at runtime, camel look for a required
      * {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+     *
+     * @see org.apache.camel.spi.Transformer
+     * @see org.apache.camel.spi.Validator
+     *
      * @param clazz Class object of the input type
      * @return the builder
      */
@@ -731,8 +736,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * at runtime, camel look for a required {@link Transformer} and apply if exists.
      * The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
      * is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}
+     *
+     * @see org.apache.camel.spi.Transformer
+     *
      * @param urn output type URN
      * @return the builder
      */
@@ -750,7 +756,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name'
      * is a fully qualified class name. For example {@code java:java.lang.String}, {@code json:ABCOrder}.
      * 
-     * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+     * @see org.apache.camel.spi.Transformer
+     * @see org.apache.camel.spi.Validator
+     *
      * @param urn output type URN
      * @return the builder
      */
@@ -765,8 +773,9 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * Declare the expected data type of the output message by Java class.
      * If the actual message type is different at runtime, camel look for a required
      * {@link Transformer} and apply if exists.
-     * 
-     * @see {@link org.apache.camel.spi.Transformer}
+     *
+     * @see org.apache.camel.spi.Transformer
+     *
      * @param clazz Class object of the output type
      * @return the builder
      */
@@ -782,7 +791,8 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
      * If the actual message type is different at runtime, camel look for a required
      * {@link Transformer} and apply if exists, and then applies {@link Validator} as well.
      * 
-     * @see {@link org.apache.camel.spi.Transformer}, {@link org.apache.camel.spi.Validator}
+     * @see org.apache.camel.spi.Transformer
+     * @see org.apache.camel.spi.Validator
      * @param clazz Class object of the output type
      * @return the builder
      */
@@ -906,7 +916,7 @@ public class RouteDefinition extends ProcessorDefinition<RouteDefinition> {
     /**
      * Whether security mask for Logging is enabled on this route.
      */
-    @XmlAttribute @Metadata(defaultValue = "false")
+    @XmlAttribute
     public void setLogMask(String logMask) {
         this.logMask = logMask;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/97f442c6/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
----------------------------------------------------------------------
diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
index 07e7bf1..73eb1bf 100644
--- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
+++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java
@@ -561,11 +561,16 @@ public class CoreEipAnnotationProcessor {
         ep = new EipOption("trace", "Trace", "attribute", "java.lang.String", false, "", docComment, false, false, null, false, null, false);
         eipOptions.add(ep);
 
-        // trace
+        // message history
         docComment = findJavaDoc(elementUtils, null, "messageHistory", null, classElement, true);
         ep = new EipOption("messageHistory", "Message History", "attribute", "java.lang.String", false, "true", docComment, false, false, null, false, null, false);
         eipOptions.add(ep);
 
+        // log mask
+        docComment = findJavaDoc(elementUtils, null, "logMask", null, classElement, true);
+        ep = new EipOption("logMask", "Log Mask", "attribute", "java.lang.String", false, "false", docComment, false, false, null, false, null, false);
+        eipOptions.add(ep);
+
         // trace
         docComment = findJavaDoc(elementUtils, null, "handleFault", null, classElement, true);
         ep = new EipOption("handleFault", "Handle Fault", "attribute", "java.lang.String", false, "", docComment, false, false, null, false, null, false);