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

Claus Ibsen commented on CAMEL-8561:
------------------------------------

We may want to keep the current name description as the summary, and then we 
can use 'detail' as the name for more documentation details, which could be the 
entire class javadoc of the endpoint class.

But lets log a new ticket if that becomes something we would like to include.

> Camel Catalog - Add better description of components and others
> ---------------------------------------------------------------
>
>                 Key: CAMEL-8561
>                 URL: https://issues.apache.org/jira/browse/CAMEL-8561
>             Project: Camel
>          Issue Type: Improvement
>          Components: tooling
>            Reporter: Claus Ibsen
>            Assignee: Claus Ibsen
>             Fix For: 2.17.0
>
>
> The description for components is taken from endpoint javadoc, maven 
> description.
> We should improve this so we have better javadoc description for all 
> components. Then its documented in one place.
> And then maybe have the description into two
> - summary
> - description
> Where summary is a one liner sentence to be used for headlines / tables to 
> tell what the component does.
> And description is the more in-depth text about the component.



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

Reply via email to