camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Claus Ibsen <>
Subject Re: [HEADS UP] - Compiling components now include validation of you included documentation
Date Mon, 22 Jun 2015 07:27:07 GMT
Hi Babak

Thanks for spotting this. I have corrected this, there were duplicated
twitter endpoint classes, and it extended a wrong base class.

Can you try again with latest code?

On Sun, Jun 21, 2015 at 11:18 PM, Babak Vahdat
<> wrote:
> Awesome!
> I noticed a typo on the following line (2 x missingDescription instead of
> missingSyntax):
> And currently while building I get the following error on camel-twitter:
> [WARNING] The component: twitter has validation errors
> [WARNING] Missing endpoint documentation for the following options:
>         block
>         timeout
>         failIfNoConsumers
> But I failed to find the 3 options above inside it's source.
> Babak
> Claus Ibsen-2 wrote
>> Hi
>> I am putting some final touches on a maven goal that is enabled by
>> default as part of building the Camel source code / components. The
>> goal validates that you have been a good person and include
>> documentation for all the component and endpoint options, include some
>> description what the component does, and added a label to categorize
>> the component, and so on.
>> This is possible because every component now includes full out of the
>> box documentation for all their options (only salesforce is pending).
>> The aim is to ensure we document all the options in the future and
>> that the docs stay up to date. We have frankly to many components that
>> get out of sync with the wiki pages.
>> Bonus goals is that we will be able to generate parts of the component
>> documentation in the future to keep it automatic up to date, and much
>> more.
>> But I just wanted to bring attention to this new validation goal. If
>> you omit some documentation etc the goal reports what the error is,
>> and which options you need to document.
>> And for documentation, its just javadoc on the setter (or getter, but
>> we favor the setter).
>> PS: I will push the code changes later when I have run a full build of
>> the code to ensure they all pass the validation.
>> --
>> Claus Ibsen
>> -----------------
>> Red Hat, Inc.
>> Email:
>> cibsen@
>> Twitter: davsclaus
>> Blog:
>> Author of Camel in Action:
>> hawtio:
>> fabric8:
> --
> View this message in context:
> Sent from the Camel Development mailing list archive at

Claus Ibsen
Red Hat, Inc.
Twitter: davsclaus
Author of Camel in Action:

View raw message