[jira] [Commented] (CAMEL-8023) Add javadoc documentation to camel-core endpoints so we have documentation out of the box

["Claus Ibsen (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CAMEL-8023?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14205201#comment-14205201 ] 

Claus Ibsen commented on CAMEL-8023:
------------------------------------

Also the javadoc of the component class itself can be improved in camel-core, as its a mix of stuf
{code}
karaf@root> camel:component-list camel-1
 Name           Description
 ----           -----------
 bean           The Bean Component is for invoking Java beans from Camel.
 binding        To compose a Camel component with a Camel data-format as a single binding unit.
 browse         The browse component.
 class          The Class Component is for invoking Java classes from Camel.
 controlbus     The control bus component.
 dataformat     The Core Camel Java DSL based router
 dataset        Component for DataSet.
 direct         Represents the component that manages DirectEndpoint. It holds the list of named direct endpoints.
 direct-vm      Represents the component that manages DirectVmEndpoint. It holds the list of named direct-vm endpoints.
 file           File component.
 language       The language component to send org.apache.camel.Exchanges to a given language and have the script being executed.
 log            The Log Component to log message exchanges to the underlying logging mechanism.
 mock           A factory of MockEndpoint instances
 properties
 ref            Component for lookup of existing endpoints bound in the org.apache.camel.spi.Registry.
 rest           The Core Camel Java DSL based router
 seda           An implementation of the SEDA components for asynchronous SEDA exchanges on a BlockingQueue within a CamelContext
 spring-event   An Event Component for working with Spring ApplicationEvents
 sql            Camel SQL support
 stub           Allows you to easily stub out a middleware transport by prefixing the URI with stub: which is handy for testing out rout
 test           Test Component.
 timer          Represents the component that manages TimerEndpoint. It holds the list of TimerConsumer objects that are started.
 validator
 vm             An implementation of the VM components for asynchronous SEDA exchanges on a BlockingQueue within the classloader tree co
 xslt           An XSLT Component for performing XSLT transforms of messages
{code}

Some are high level others is a bit more detailed. I guess we should make it a nice one sentence summary of what the component does, very briefly. 


> Add javadoc documentation to camel-core endpoints so we have documentation out of the box
> -----------------------------------------------------------------------------------------
>
>                 Key: CAMEL-8023
>                 URL: https://issues.apache.org/jira/browse/CAMEL-8023
>             Project: Camel
>          Issue Type: Sub-task
>          Components: camel-core
>            Reporter: Claus Ibsen
>             Fix For: 2.15.0
>
>
> See parent ticket.
> For each of the components in camel-core, we need to document each @UriParam option. This is done by adding javadoc to the setter method.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)