[Hawkular-dev] Coming to Parent: publishing JavaDoc and sources via Maven

Peter Palaga ppalaga at redhat.com
Thu Apr 30 03:27:58 EDT 2015


Hi *,

I have checked the impact of

   https://github.com/hawkular/hawkular-parent-pom/pull/20

in Alerts, Inventory, Agent, Accounts and Metrics. It works everywhere, 
producing just a few warnings that can be fixed later. Therefore, I 
merged the above PR.

-- P

On 2015-03-30 21:46, Peter Palaga wrote:
> On 03/30/2015 09:34 PM, Peter Palaga wrote:
>> Hi Jay, there is just a couple of them in Bus - see the attached file. -- P
>
> There is no single warning about missing JavaDoc. All the warnings are
> about inconsistencies and broken syntax inside JavaDoc which indeed is
> worth fixing. -- P
>
>> On 03/30/2015 04:38 PM, Jay Shaughnessy wrote:
>>>
>>> Hi Peter, to get an idea of the type and volume of issues this will
>>> report, can you list the current bus warnings you're seeing?
>>>
>>>
>>> On 3/30/2015 9:37 AM, Peter Palaga wrote:
>>>> Hi *, there is a question about handling JavaDoc checks violations at
>>>> the bottom.
>>>>
>>>> I have added maven-javadoc-plugin and maven-source-plugin to the new
>>>> "release" profile in Hawkular Parent.
>>>> https://github.com/hawkular/hawkular-parent-pom/pull/20
>>>>
>>>> I have tested the above only with Hawkular Bus. Therefore, please test
>>>> the setup with your Hawkular component:
>>>> * Make whatever is appropriate to make your component use the pom from
>>>> https://github.com/hawkular/hawkular-parent-pom/pull/20
>>>> * Invoke
>>>>
>>>>      mvn clean install -Prelease
>>>>
>>>> * Figure out, how many "[WARNING] Javadoc Warnings" are there.
>>>> * Look into target folders if *-javadoc.jar and *-sources.jar files were
>>>> generated
>>>>
>>>>
>>>> == Handling JavaDoc checks violations
>>>>
>>>> The present setup turns all javadoc violations into warnings using
>>>> -Xdoclint:none [1]. I can only say that there *are* violations in Bus.
>>>>
>>>> I think that we should aim at having no violations at all - i.e. that
>>>> the components should be given a week or two to fix and that we should
>>>> switch to -Xdoclint:all after that. WDYT?
>>>>
>>>> More about -Xdoclint can be found in [2].
>>>>
>>>> Thanks,
>>>>
>>>> Peter
>>>>
>>>> [1]
>>>> https://github.com/hawkular/hawkular-parent-pom/commit/d54a8d03b4ef251d594f1cc4ff3fadfa4a1d4dd3#diff-600376dffeb79835ede4a0b285078036R110
>>>>
>>>>
>>>> [2]http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html
>>>> _______________________________________________
>>>> hawkular-dev mailing list
>>>> hawkular-dev at lists.jboss.org
>>>> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>>>>
>>>>
>>>
>>>
>>>
>>> _______________________________________________
>>> hawkular-dev mailing list
>>> hawkular-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>>>
>>
>>
>>
>> _______________________________________________
>> hawkular-dev mailing list
>> hawkular-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>>
>
> _______________________________________________
> hawkular-dev mailing list
> hawkular-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>



More information about the hawkular-dev mailing list