Since the annotation will be an in a o.a.camel package, I would drop the
redundant Camel prefix too.
Hadrian
On Apr 20, 2011, at 12:38 PM, Charles Moulliard wrote:
> Additional information like isTransactional = True, False, type =
> "ProducerOnly, ConsumerOnly,Both" could be added
>
> @CamelComponent(name="","description="",example="", pageUrl="",
> isTransactional="true/false", type="ProducerOnly, ConsumerOnly,Both")
> public class Component {
>
>
> On Wed, Apr 20, 2011 at 5:05 PM, Eric Johnson <emjohn...@fusesource.com>
> wrote:
>> It may be a bit of a "new puppy" item, but I think it is a great idea.
>> Self documenting code is always a good idea.
>>
>>
>> On Wed, Apr 20, 2011 at 10:50 AM, Charles Moulliard
>> <cmoulli...@gmail.com> wrote:
>>> Hi,
>>>
>>> I would like to suggest that we add annotation to document the
>>> properties of the Camel Component class which are used customise the
>>> component according to the keys defined into the URIs.
>>>
>>> What do you about that ?
>>>
>>> idea
>>>
>>> URI => componentName:property1:property2....?key1=value&key2=value .....
>>>
>>> @CamelComponent(name="","description="",example="", pageUrl="")
>>> public class Component {
>>>
>>> @CamelComponentKey(name="", description="", type="boolean, string")
>>> String key1;
>>>
>>> @CamelComponentKey(name="", description="", type="boolean, string")
>>> String key2;
>>>
>>> String key3;
>>> ...
>>> }
>>>
>>> We could use those annotations to document camel component (when
>>> generating pdf, html, ...) or provide URI definition when using
>>> autocompletion in Eclipse, IntelliJ, ....
>>>
>>> Regards,
>>>
>>> Charles Moulliard
>>>
>>> Sr. Principal Solution Architect - FuseSource
>>> Apache Committer
>>>
>>> Blog : http://cmoulliard.blogspot.com
>>> Twitter : http://twitter.com/cmoulliard
>>> Linkedin : http://www.linkedin.com/in/charlesmoulliard
>>> Skype: cmoulliard
>>>
>>
>>
>>
>> --
>> Principle Technical Writer
>> FuseSource
>> Phone: (781) 280-4174
>> E-Mail: emjohn...@fusesource.com
>> Blog: http://documentingit.blogspot.com/
>> Twitter: finnmccumial
>>
