[PAXSB-92] Fixed bad JavaDoc (failing release build)

pax-swissbox-converter/pom.xml

@@ -50,11 +50,30 @@
   </build>
 
   <dependencies>
+    <dependency>
+      <groupId>com.google.code.findbugs</groupId>
+      <artifactId>annotations</artifactId>
+      <version>3.0.1</version>
+      <scope>provided</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>com.google.code.findbugs</groupId>
+          <!-- The types of this artifact are already shaded inside the :annotations artifact -->
+          <artifactId>jsr305</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>net.jcip</groupId>
+          <!-- The types of this artifact are already shaded inside the :annotations artifact -->
+          <artifactId>jcip-annotations</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
     <!-- Test dependencies -->
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
     </dependency>
   </dependencies>
 
-</project>
+</project>

pax-swissbox-converter/src/main/java/org/osgi/service/blueprint/container/Converter.java

@@ -17,12 +17,14 @@
  */
 package org.osgi.service.blueprint.container;
 
+import javax.annotation.concurrent.ThreadSafe;
+
 /**
  * Type converter to convert an object to a target type.
  *
  * @version $Revision: 7564 $
- * @ThreadSafe
  */
+@ThreadSafe
 public interface Converter
 {
 
@@ -52,5 +54,5 @@ public interface Converter
      *                   returned <code>true</code>.
      */
     Object convert( Object sourceObject, ReifiedType targetType)
-			throws Exception;
-}
+            throws Exception;
+}

pax-swissbox-converter/src/main/java/org/osgi/service/blueprint/container/ReifiedType.java

@@ -17,6 +17,8 @@
  */
 package org.osgi.service.blueprint.container;
 
+import javax.annotation.concurrent.Immutable;
+
 /**
  * Provides access to a concrete type and its optional generic type parameters.
  *
@@ -43,8 +45,8 @@
  * optional type parameters as Reified Types.
  *
  * @version $Revision: 7564 $
- * @Immutable
  */
+@Immutable
 public class ReifiedType
 {
 

pax-swissbox-core/src/main/java/org/ops4j/pax/swissbox/core/BundleUtils.java

@@ -81,15 +81,14 @@ public static BundleContext getBundleContext( final Bundle bundle )
         // well, discovery failed
         return null;
     }
-    
+
     /**
      * Returns any bundle with the given symbolic name, or null if no such bundle exists. If there
      * are multiple bundles with the same symbolic name and different version, this method returns
      * the first bundle found.
-     * 
+     *
      * @param bc bundle context
      * @param symbolicName bundle symbolic name
-     * @param version bundle version
      * @return matching bundle, or null
      */
     public static Bundle getBundle( BundleContext bc, String symbolicName )
@@ -99,7 +98,7 @@ public static Bundle getBundle( BundleContext bc, String symbolicName )
 
     /**
      * Returns a list of all bundles with the given symbolic name.
-     * 
+     *
      * @param bc bundle context
      * @param symbolicName bundle symbolic name
      * @return matching bundles. The list may be empty, but never null.
@@ -120,7 +119,7 @@ public static List<Bundle> getBundles( BundleContext bc, String symbolicName )
     /**
      * Returns the bundle with the given symbolic name and the given version, or null if no such
      * bundle exists
-     * 
+     *
      * @param bc bundle context
      * @param symbolicName bundle symbolic name
      * @param version bundle version

pax-swissbox-extender/src/main/java/org/ops4j/pax/swissbox/extender/ManifestFilter.java

@@ -22,7 +22,7 @@
 /**
  * Manifest entries filter.
  *
- * @auth Alin Dreghiciu
+ * @author Alin Dreghiciu
  * @since 0.2.0, February 09, 2008
  */
 public interface ManifestFilter

pax-swissbox-framework/src/main/java/org/ops4j/pax/swissbox/framework/FrameworkFactoryFinder.java

@@ -23,17 +23,17 @@
 import static org.ops4j.spi.ServiceProviderFinder.loadUniqueServiceProvider;
 
 import java.util.List;
-
+import java.util.ServiceLoader;
 import org.osgi.framework.launch.FrameworkFactory;
 
 /**
  * Convenience class for obtaining OSGi {@link FrameworkFactory} implementations
  * via the {@link ServiceLoader}.
- * 
+ *
  * @author Harald Wellmann
  */
-public class FrameworkFactoryFinder 
-{    
+public class FrameworkFactoryFinder
+{
     public static List<FrameworkFactory> findFrameworkFactories()
     {
         return findServiceProviders( FrameworkFactory.class );

pax-swissbox-framework/src/main/java/org/ops4j/pax/swissbox/framework/RemoteFramework.java

@@ -28,7 +28,7 @@
 
 /**
  * An RMI-capable variant of the OSGi {@link Framework} interface.
- * 
+ *
  * @author Harald Wellmann
  */
 public interface RemoteFramework extends Remote
@@ -37,13 +37,13 @@ public interface RemoteFramework extends Remote
      * System property key for RMI registry port.
      */
     public static final String RMI_PORT_KEY = "pax.swissbox.framework.rmi.port";
-    
+
     /**
      * System property key for the name to be used for the remote framework in the
      * RMI registry.
      */
     public static final String RMI_NAME_KEY = "pax.swissbox.framework.rmi.name";
-    
+
     /**
      * System property key for the framework shutdown timeout (milliseconds in
      * decimal representation).
@@ -52,34 +52,28 @@ public interface RemoteFramework extends Remote
 
     /**
      * Initializes the framework.
-     * 
-     * @see {@link Framework#init}
-     * @throws RemoteException
-     * @throws BundleException
+     *
+     * @see Framework#init()
      */
     void init() throws RemoteException, BundleException;
 
     /**
      * Starts the framework.
-     * 
-     * @see {@link Framework#start}
-     * @throws RemoteException
-     * @throws BundleException
+     *
+     * @see Framework#start()
      */
     void start() throws RemoteException, BundleException;
 
     /**
      * Stops the framework.
-     * 
-     * @see {@link Framework#start}
-     * @throws RemoteException
-     * @throws BundleException
+     *
+     * @see Framework#start()
      */
     void stop() throws RemoteException, BundleException;
 
     /**
      * Installs a bundle remotely.
-     * 
+     *
      * @param bundleUrl url of the bundle to be installed. The url must be accessible from the
      *        remote framework.
      * @return bundle id of the installed bundle
@@ -91,7 +85,7 @@ long installBundle( String bundleUrl )
 
     /**
      * Installs a bundle remotely, sets its start level and optionally starts it.
-     * 
+     *
      * @param bundleUrl url of the bundle to be installed. The url must be accessible from the
      *        remote framework.
      * @param start indicates whether the bundle will be started
@@ -106,7 +100,7 @@ long installBundle( String bundleUrl, boolean start, int startLevel )
     /**
      * Installs a bundle remotely, given the bundle content, autostart it if requested and set its
      * startlevel
-     * 
+     *
      * @param bundleLocation The location identifier of the bundle to install
      * @param bundleData bundle content as a byte array
      * @param start indicates whether the bundle will be started
@@ -120,7 +114,7 @@ long installBundle( String bundleLocation, byte[] bundleData, boolean start, int
 
     /**
      * Installs a bundle remotely, given the bundle content.
-     * 
+     *
      * @param bundleLocation The location identifier of the bundle to install
      * @param bundle bundle content as a byte array
      * @return bundle id of the installed bundle
@@ -132,7 +126,7 @@ long installBundle( String bundleLocation, byte[] bundle )
 
     /**
      * Starts a bundle.
-     * 
+     *
      * @param bundleId id of the bundle to be started
      * @throws RemoteException - Remote communication related exception (mandatory by RMI)
      * @throws BundleException - Re-thrown from starting the bundle
@@ -142,7 +136,7 @@ void startBundle( long bundleId )
 
     /**
      * Stops a bundle.
-     * 
+     *
      * @param bundleId id of the bundle to be stopped
      * @throws RemoteException - Remote communication related exception (mandatory by RMI)
      * @throws BundleException - Re-thrown from stopping the bundle
@@ -152,7 +146,7 @@ void stopBundle( long bundleId )
 
     /**
      * Sets bundle start level.
-     * 
+     *
      * @param bundleId id of the bundle to which the start level should be set
      * @param startLevel bundle start level
      * @throws RemoteException - Remote communication related exception (mandatory by RMI)
@@ -163,14 +157,14 @@ void setBundleStartLevel( long bundleId, int startLevel )
 
     /**
      * Waits for a bundle to be in a certain state and returns.
-     * 
+     * When used with Pax Exam, throws org.ops4j.pax.exam.TimeoutException
+     * if timeout occurred and expected state has not being reached.
+     *
      * @param bundleId bundle id
      * @param state expected state
      * @param timeoutInMillis max time to wait for state
      * @throws RemoteException - Remote communication related exception (mandatory by RMI)
      * @throws BundleException - If bundle cannot be found
-     * @throws org.ops4j.pax.exam.TimeoutException - if timeout occured and expected state has not
-     *         being reached
      */
     void waitForState( long bundleId, int state, long timeoutInMillis )
         throws RemoteException, BundleException;
@@ -187,7 +181,7 @@ void uninstallBundle( long id )
      * Looks up a service matching the given filter and invokes a service method with the given
      * name. The method is expected to have either a parameter of type Object[] or no parameters. It
      * will be invoked with an empty argument list.
-     * 
+     *
      * @param filter LDAP service filter
      * @param methodName service method name
      * @throws RemoteException - Remote communication related exception (mandatory by RMI)
@@ -197,28 +191,20 @@ void uninstallBundle( long id )
 
     /**
      * Invokes a method on this reference in the remote framework
-     * 
-     * @param name
-     * @param args
-     * @return
      */
     Object invokeMethodOnService( RemoteServiceReference reference, String methodName,
             Object... args ) throws RemoteException, Exception;
 
     /**
      * Invokes a method on this reference in the remote framework
-     * 
-     * @param name
-     * @param args
-     * @return
      */
     Object invokeMethodOnService( RemoteServiceReference reference, String methodName,
             Class<?>[] parameterTypes, Object[] args ) throws RemoteException, Exception;
 
     /**
      * Fetch an array of {@link RemoteServiceReference} to interact with them, this is a snapshot of
      * the current state and must be recalled to update
-     * 
+     *
      * @param filter
      * @return
      * @throws RemoteException
@@ -231,7 +217,7 @@ RemoteServiceReference[] getServiceReferences( String filter ) throws RemoteExce
     /**
      * Fetch an array of {@link RemoteServiceReference} to interact with them, this is a snapshot of
      * the current state and must be recalled to update
-     * 
+     *
      * @param filter
      * @param timeout wait the specified amout of time in relation to the timeunit for a service
      *        matchign the filter to appear
@@ -245,33 +231,36 @@ RemoteServiceReference[] getServiceReferences( String filter, long timeout, Time
 
     /**
      * Sets the framework startlevel.
-     * 
-     * @see {@link StartLevel#setStartLevel(int)}
+     *
      * @param startLevel
      * @throws RemoteException
+     *
+     * @see StartLevel#setStartLevel(int)
      */
     void setFrameworkStartLevel( int startLevel ) throws RemoteException;
 
     /**
      * Sets the framework startlevel and waits for at most the given timeout (in ms) for the
      * startlevel to be reached.
-     * 
-     * @see {@link StartLevel#setStartLevel(int)}
+     *
      * @param startLevel
      * @throws RemoteException
      * @return true if the start level has been reached within the given timeout
+     *
+     * @see StartLevel#setStartLevel(int)
      */
     boolean setFrameworkStartLevel( int startLevel, long timeout )
         throws RemoteException;
 
     /**
      * Returns the state of the bundle with the given ID.
-     * 
-     * @see {@link org.osgi.framework.Bundle#getState()}
+     *
      * @param bundleId bundle ID
      * @return state of bundle
      * @throws RemoteException
      * @throws BundleException if there is no bundle with the given ID
+     *
+     * @see org.osgi.framework.Bundle#getState()
      */
     int getBundleState( long bundleId ) throws RemoteException, BundleException;
 }

pax-swissbox-optional-jcl/src/main/java/org/apache/commons/logging/Log.java

@@ -39,21 +39,20 @@ of its interface so that this Log4J OSGi bundle can export the JCL interface
  * The mapping of these log levels to the concepts used by the underlying
  * logging system is implementation dependent.
  * The implemention should ensure, though, that this ordering behaves
- * as expected.</p>
+ * as expected.
  *
  * <p>Performance is often a logging concern.
  * By examining the appropriate property,
  * a component can avoid expensive operations (producing information
  * to be logged).</p>
  *
  * <p> For example,
- * <code><pre>
+ * <pre>
  *    if (log.isDebugEnabled()) {
  *        ... do something expensive ...
  *        log.debug(theResult);
  *    }
- * </pre></code>
- * </p>
+ * </pre>
  *
  * <p>Configuration of the underlying logging system will generally be done
  * external to the Logging APIs, through whatever mechanism is supported by