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 2019/10/01 08:07:02 UTC

[camel] branch master updated: Update endpoint-annotations.adoc

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 ed0796c  Update endpoint-annotations.adoc
ed0796c is described below

commit ed0796c2bd7c3a1fafe9759f32911c35bf7a837d
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Tue Oct 1 10:06:54 2019 +0200

    Update endpoint-annotations.adoc
---
 .../modules/ROOT/pages/endpoint-annotations.adoc   | 23 ++++------------------
 1 file changed, 4 insertions(+), 19 deletions(-)

diff --git a/docs/user-manual/modules/ROOT/pages/endpoint-annotations.adoc b/docs/user-manual/modules/ROOT/pages/endpoint-annotations.adoc
index c84f30f..6b83464 100644
--- a/docs/user-manual/modules/ROOT/pages/endpoint-annotations.adoc
+++ b/docs/user-manual/modules/ROOT/pages/endpoint-annotations.adoc
@@ -30,26 +30,11 @@ configuration parameters; then the class of this field should be
 annotated with one or more @UriParam or @UriParams annotations
 |=======================================================================
 
-For example here is the
-https://github.com/apache/camel/blob/trunk/camel-core/src/main/java/org/apache/camel/component/timer/TimerEndpoint.java#L40[TimerEndpoint],
-notice the use of these annotations and in its base classes.
+For example see the `TimerEndpoint` from the `camel-timer` component and
+notice how its using these annotations.
 
 Not only are the annotations useful for automatically generating the
 documentation; we can use them to refine the validation of the code
 during configuration and they can be useful for tool providers so they
-can more easily introspect the configuration options. See the
-xref:componentconfiguration.adoc[ComponentConfiguration] documentation
-on the tooling aspect.
-
-Using the UriEndpointComponent base class
-
-If you use the @UriEndpoint annotation on your Endpoint along with one
-or more @UriParam / @UriParams annotations on your class (or any base
-classes of your endpoint) its recommended that your Component class
-inherit from the UriEndpointComponent base class as that means your
-Component will automatically generate better metadata for the
-xref:componentconfiguration.adoc[ComponentConfiguration] API.
-
-This will allow your component to work better inside tools which make
-use of the xref:componentconfiguration.adoc[ComponentConfiguration] API
-to generate nice forms and so forth.
+can more easily introspect the configuration options.
+