[camel] branch master updated: CAMEL-16211: Added javadoc about api usage.

[davsclaus]

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new 4ea49f4  CAMEL-16211: Added javadoc about api usage.
4ea49f4 is described below

commit 4ea49f45f864f28e1ca291845703c002872fab00
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Feb 17 10:10:38 2021 +0100

    CAMEL-16211: Added javadoc about api usage.
---
 .../src/main/java/org/apache/camel/model/RoutesDefinition.java      | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git 
a/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java
 
b/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java
index 85adf9e..22ef8c8 100644
--- 
a/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java
+++ 
b/core/camel-core-model/src/main/java/org/apache/camel/model/RoutesDefinition.java
@@ -148,6 +148,8 @@ public class RoutesDefinition extends 
OptionalIdentifiedDefinition<RoutesDefinit
     /**
      * Creates a new route
      *
+     * Prefer to use the from methods when creating a new route.
+     *
      * @return the builder
      */
     public RouteDefinition route() {
@@ -186,7 +188,9 @@ public class RoutesDefinition extends 
OptionalIdentifiedDefinition<RoutesDefinit
     }
 
     /**
-     * Creates a new route using the given route
+     * Creates a new route using the given route.
+     * <p/>
+     * <b>Important:</b> This API is NOT intended for Camel end users, but 
used internally by Camel itself.
      *
      * @param  route the route
      * @return       the builder