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

james strachan commented on CAMEL-6304:
---------------------------------------

The annotations (@UriEndpoint, @UriParam, @UriParams for nested param objects) 
are in the tooling/spi-annotations jar as that makes it easier to do APT stuff. 
Then the tooling/apt module contains an APT annotation processor to generate a 
HTML document from the java code; using the annotations and javadoc comments
                
> make it easier to auto-document components/endpoints (like maven goals); use 
> annotations to automatically generate configuration documentation
> ----------------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: CAMEL-6304
>                 URL: https://issues.apache.org/jira/browse/CAMEL-6304
>             Project: Camel
>          Issue Type: New Feature
>            Reporter: james strachan
>            Assignee: james strachan
>
> Right now documentation is done on the wiki by hand which is pretty error 
> prone; its also kinda painful to handle every single camel version.
> It would be nice to automatically create the component/endpoint configuration 
> documentation as a maven report; we could also include this HTML into the jar 
> so folks can refer to the documentation for the camel components on their 
> classpath.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to