[ARIES-552] Fix javadoc warnings

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: util-0.4, proxy uber bundle 0.4, proxy.api-0.4
• Component/s: Application, Blueprint, JNDI, JPA, Util
• Assignee: Alasdair Nottingham
• Reporter: Alasdair Nottingham
• Created: 21/Jan/11 20:41
• Updated: 26/Oct/11 16:47
• Resolved: 21/Jan/11 22:24

Description

Building the javadoc causes warnings. Need to fix them.

Util project warnings:
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/util/src/main/java/org/apache/aries/util/tracker/BundleTrackerFactory.java:66: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/util/src/main/java/org/apache/aries/util/tracker/BundleTrackerFactory.java:55: warning - @param argument "bundleSymbolicName" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/util/src/main/java/org/apache/aries/util/tracker/BundleTrackerFactory.java:55: warning - @param argument "bundleVersion" is not a parameter name.

Proxy project warnings:
[WARNING] Javadoc Warnings
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/proxy/proxy-api/src/main/java/org/apache/aries/proxy/ProxyManager.java:46: warning - Tag @link: can't find createProxyFactory(boolean) in org.apache.aries.proxy.ProxyManager

Application project warning:
[WARNING] Javadoc Warnings
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/ApplicationMetadata.java:35: warning - Tag @see: missing final '>': "<a href="http://incubator.apache.org/aries/applications.html">
[WARNING] http://incubator.apache.org/aries/applications.html</a>."
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/ApplicationMetadata.java:84: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/DeploymentMetadata.java:60: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/DeploymentMetadata.java:67: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/DeploymentMetadata.java:73: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/ServiceDeclaration.java:28: warning - Tag @see: missing final '>': "<a href="http://incubator.apache.org/aries/applications.html">
[WARNING] http://incubator.apache.org/aries/applications.html</a>."
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/VersionRange.java:35: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/VersionRange.java:71: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/VersionRange.java:53: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/VersionRange.java:59: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/VersionRange.java:65: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/AriesApplication.java:38: warning - Tag @see: missing final '>': "<a href="http://incubator.apache.org/aries/applications.html">
[WARNING] http://incubator.apache.org/aries/applications.html</a>."
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/AriesApplicationEvent.java:37: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/AriesApplicationEvent.java:31: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/AriesApplicationManager.java:55: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/convert/BundleConversion.java:44: warning - @param argument "The" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFramework.java:98: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFramework.java:92: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFramework.java:86: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFramework.java:59: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkConfigurationFactory.java:32: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkConfigurationFactory.java:42: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkFactory.java:34: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkManager.java:48: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkManager.java:55: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkManager.java:65: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/framework/BundleFrameworkManager.java:77: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepository.java:69: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepository.java:63: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepository.java:56: warning - @param argument "ctx" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepositoryManager.java:44: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepositoryManager.java:37: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepositoryManager.java:78: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepositoryManager.java:67: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/repository/BundleRepositoryManager.java:55: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/resolve/DeploymentManifestManager.java:69: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/resolve/DeploymentManifestManager.java:55: warning - @param argument "appMeta" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/resolve/DeploymentManifestManager.java:55: warning - @param argument "useBundleSet" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/resolve/DeploymentManifestManager.java:55: warning - @param argument "appImportServices" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/management/spi/resolve/PostResolveTransformer.java:34: warning - @param argument "bundles" is not a parameter name.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/DeployedBundles.java:101: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/ExportedBundle.java:41: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/ImportedBundle.java:32: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/ModelledResource.java:76: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/ModelledResource.java:94: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/ModelledResourceManager.java:31: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/application/application-api/src/main/java/org/apache/aries/application/modelling/utils/ModellingHelper.java:33: warning - @return tag has no arguments.

JPA:
[WARNING] Javadoc Warnings
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/PersistenceUnitConstants.java:30: warning - Tag @link: reference not found: Version
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/PersistenceUnitConstants.java:30: warning - Tag @link: reference not found: Version
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/parsing/ParsedPersistenceUnit.java:82: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/parsing/ParsedPersistenceUnit.java:89: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/parsing/PersistenceDescriptor.java:38: warning - @return tag has no arguments.
[WARNING] /Users/nottinga/Documents/apache/aries/trunk/jpa/jpa-api/src/main/java/org/apache/aries/jpa/container/PersistenceUnitConstants.java:30: warning - Tag @link: reference not found: Version