You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cxf.apache.org by "Robert Liguori (JIRA)" <ji...@apache.org> on 2010/10/21 18:56:19 UTC
[jira] Created: (CXF-3079) Javadoc refinements are necesarry as
exposed by the CXF build process (mvn -e)
Javadoc refinements are necesarry as exposed by the CXF build process (mvn -e)
------------------------------------------------------------------------------
Key: CXF-3079
URL: https://issues.apache.org/jira/browse/CXF-3079
Project: CXF
Issue Type: Improvement
Affects Versions: 2.3.0
Reporter: Robert Liguori
Priority: Trivial
Javadoc refinements are necesarry as exposed by the CXF build process (mvn -e).
Examples of Javadoc -related warnings seen in the build process:
...warning - @param argument "schemas" is not a parameter name.
...warning - @return tag has no argument
Note that these refinements are trivial in nature and the only downside is the time and commitment to make the changes.
The benefits include a better Javadoc documentation set and removal of the warnings from the detailed build process.
Note: Using an IDE, this task should not take over an hour or two. Perhaps 3 if the developer takes the time to add the proper descriptions for the Javadoc tags, rather than removing them.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (CXF-3079) Javadoc refinements are necesarry as
exposed by the CXF build process (mvn -e)
Posted by "Robert Liguori (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/CXF-3079?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12923576#action_12923576 ]
Robert Liguori commented on CXF-3079:
-------------------------------------
Here are the warnings:
30 warnings
[WARNING] Javadoc Warnings
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.binding"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.endpoint"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.interceptor"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.phase"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.service"
[WARNING] javadoc: warning - Multiple sources of package comments found for package "org.apache.cxf.transport"
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\annotations\DataBinding.java:42: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\annotations\EndpointProperties.java:40: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\annotations\EndpointProperty.java:46: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\annotations\EndpointProperty.java:40: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\clustering\FailoverStrategy.java:63: warning - @param argument "alternates" is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:36: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:54: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:45: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:76: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:64: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:76: warning - @param argument "<T>" is not a type parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:76: warning - @param argument "type" is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:76: warning - @param argument "property" is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:95: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\configuration\ConfiguredBeanLocator.java:86: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\continuations\Continuation.java:36: warning - @param argument "timeout." is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\endpoint\Client.java:240: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\io\StaxValidationManager.java:39: warning - @param argument "schemas" is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\phase\AbstractPhaseInterceptor.java:75: warning - @param argument "p" is not a parameter name.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\service\model\SchemaInfo.java:86: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\transport\Observable.java:38: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\ws\policy\AssertionBuilderRegistry.java:56: warning - @return tag has no arguments.
[WARNING] C:\_CXF\apache-cxf-2.3.0-src\apache-cxf-2.3.0-src\api\src\main\java\org\apache\cxf\wsdl\WSDLManager.java:100: warning - @return tag has no arguments.
> Javadoc refinements are necesarry as exposed by the CXF build process (mvn -e)
> ------------------------------------------------------------------------------
>
> Key: CXF-3079
> URL: https://issues.apache.org/jira/browse/CXF-3079
> Project: CXF
> Issue Type: Improvement
> Affects Versions: 2.3.0
> Reporter: Robert Liguori
> Priority: Trivial
> Original Estimate: 2h
> Remaining Estimate: 2h
>
> Javadoc refinements are necesarry as exposed by the CXF build process (mvn -e).
> Examples of Javadoc -related warnings seen in the build process:
> ...warning - @param argument "schemas" is not a parameter name.
> ...warning - @return tag has no argument
> Note that these refinements are trivial in nature and the only downside is the time and commitment to make the changes.
> The benefits include a better Javadoc documentation set and removal of the warnings from the detailed build process.
> Note: Using an IDE, this task should not take over an hour or two. Perhaps 3 if the developer takes the time to add the proper descriptions for the Javadoc tags, rather than removing them.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.