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

[Peter Palaga]

Hi Jay, there is just a couple of them in Bus - see the attached file. -- 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
>

-------------- next part --------------
...
20 warnings
[WARNING] Javadoc Warnings
[WARNING] /home/data/gtn-m2-repository/com/google/guava/guava/16.0.1/guava-16.0.1.jar(com/google/common/util/concurrent/ExecutionList.class): warning: Cannot find annotation method 'value()' in type 'GuardedBy': class file for javax.annotation.concurrent.GuardedBy not found
[WARNING] /home/data/gtn-m2-repository/com/google/guava/guava/16.0.1/guava-16.0.1.jar(com/google/common/util/concurrent/ExecutionList.class): warning: Cannot find annotation method 'value()' in type 'GuardedBy'
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/ConnectionContextFactory.java:270: warning - Missing closing '}' character for inline tag: "{@link #createOrReuseConnection(ConnectionContext, boolean)."
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:57: warning - Tag @see:illegal character: "123" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createConsumerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:57: warning - Tag @see:illegal character: "64" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createConsumerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:96: warning - Tag @see:illegal character: "123" in "{@link ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:96: warning - Tag @see:illegal character: "64" in "{@link ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:167: warning - Tag @see:illegal character: "123" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:167: warning - Tag @see:illegal character: "64" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:257: warning - Tag @see:illegal character: "123" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:257: warning - Tag @see:illegal character: "64" in "{@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}"
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:167: warning - Tag @link: can't find sendRPC(ProducerConnectionContext, BasicMessage) in org.hawkular.bus.common.MessageProcessor
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:57: warning - Tag @see: reference not found: {@link org.hawkular.bus.common.ConnectionContextFactory#createConsumerConnectionContext(Endpoint)}
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:96: warning - Tag @see: reference not found: {@link ConnectionContextFactory#createProducerConnectionContext(Endpoint)}
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:167: warning - @param argument "T" is not a parameter name.
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:167: warning - Tag @see: reference not found: {@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:257: warning - @param argument "R" is not a parameter name.
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/MessageProcessor.java:257: warning - Tag @see: reference not found: {@link org.hawkular.bus.common.ConnectionContextFactory#createProducerConnectionContext(Endpoint)}
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/consumer/BasicMessageListener.java:59: warning - @param argument "message" is not a parameter name.
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-common/src/main/java/org/hawkular/bus/common/consumer/RPCBasicMessageListener.java:130: warning - @param argument "message" is not a parameter name.
...
1 warning
[WARNING] Javadoc Warnings
[WARNING] /home/ppalaga/git/hawkular-bus/hawkular-bus-test-common/src/main/java/org/hawkular/bus/common/test/SimpleTestListener.java:34: warning - Tag @link: can't find getBasicMessage() in org.hawkular.bus.common.test.SimpleTestListener