camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Claus Ibsen (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (CAMEL-11146) Update description for all data formats and languages on big readme file
Date Thu, 27 Apr 2017 11:55:04 GMT

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

Claus Ibsen edited comment on CAMEL-11146 at 4/27/17 11:54 AM:
---------------------------------------------------------------

I think we need to update those in the class javadoc of the model classes in camel-core, eg
inside the model.languages and model.dataformats. 

Then its a bit similar to compoennts which is also the class javadoc on the endpoint class.

However they may grab the description from the pom.xml also, so we may need to tweak the maven
tooling to avoid that.

But the harder part is to come up with good descriptions for all those. instead of just Camel
Groovy support.


was (Author: davsclaus):
I think we need to update those in the class javadoc of the model classes in camel-core, eg
inside the model.languages and model.dataformats. 


> Update description for all data formats and languages on big readme file
> ------------------------------------------------------------------------
>
>                 Key: CAMEL-11146
>                 URL: https://issues.apache.org/jira/browse/CAMEL-11146
>             Project: Camel
>          Issue Type: Task
>          Components: documentation
>            Reporter: Claus Ibsen
>             Fix For: 2.20.0
>
>
> This page
> https://github.com/apache/camel/tree/master/components
> We should improve description for all those data formats and languages as they are not
very informative. They should have a short description like we do for components.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message