309185 even more javadoc fixes

git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1901 7e9141cc-0065-0410-87d8-b60c137991c4

jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationSupport.java

@@ -97,7 +97,7 @@ public class ContinuationSupport
      * deployed. It may be an implementation native to the container (eg
      * org.eclipse.jetty.server.AsyncContinuation) or one of the utility
      * implementations provided such as an internal <code>FauxContinuation</code>
-     * or a real implementation like {@link Servlet3Continuation}.
+     * or a real implementation like {@link org.eclipse.jetty.continuation.Servlet3Continuation}.
      * @param request The request 
      * @return a Continuation instance
      */

jetty-deploy/src/main/java/org/eclipse/jetty/deploy/AppLifeCycle.java

@@ -54,8 +54,6 @@ public class AppLifeCycle extends Graph
          *            the node being processed
          * @param app
          *            the app being processed
-         * @param deploymentManager
-         *            the {@link DeploymentManager} tracking the {@link AppLifeCycle} and {@link App}
          * @throws Exception
          *             if any problem severe enough to halt the AppLifeCycle processing
          */

jetty-http/src/main/java/org/eclipse/jetty/http/HttpParser.java

@@ -226,7 +226,7 @@ public class HttpParser implements Parser
     /* ------------------------------------------------------------------------------- */
     /**
      * Parse until next Event.
-     * @returns number of bytes filled from endpoint or -1 if fill never called.
+     * @return number of bytes filled from endpoint or -1 if fill never called.
      */
     public long parseNext() throws IOException
     {

jetty-osgi/jetty-osgi-boot-jsp/src/main/java/org/eclipse/jetty/osgi/boot/jasper/WebappRegistrationCustomizerImpl.java

@@ -117,7 +117,7 @@ public class WebappRegistrationCustomizerImpl implements WebappRegistrationCusto
      * Support only 2 types of packaging for the bundle: - the bundle is a jar (recommended for runtime.) - the bundle is a folder and contain jars in the root
      * and/or in the lib folder (nice for PDE developement situations) Unsupported: the bundle is a jar that embeds more jars.
      * 
-     * @return
+     * @return array of URLs
      * @throws Exception
      */
     public URL[] getJarsWithTlds(OSGiAppProvider provider, BundleFileLocatorHelper locatorHelper) throws Exception

jetty-osgi/jetty-osgi-boot-warurl/src/main/java/org/eclipse/jetty/osgi/boot/warurl/internal/WarURLConnection.java

@@ -99,7 +99,7 @@ public class WarURLConnection extends URLConnection
     
     /**
      * @param url The file url (for example)
-     * @param The manifest to use as a replacement to the jar file inside
+     * @param mf The manifest to use as a replacement to the jar file inside
      * the file url.
      */
     public WarURLConnection(URL url, Manifest mf) throws IOException

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/JettyBootstrapActivator.java

@@ -148,8 +148,8 @@ public class JettyBootstrapActivator implements BundleActivator
      * registers it as an OSGi service. The tracker
      * {@link JettyContextHandlerServiceTracker} will do the actual deployment.
      * 
-     * @param context
+     * @param contributor
-     *            The current bundle context
+     *            The bundle
      * @param webappFolderPath
      *            The path to the root of the webapp. Must be a path relative to
      *            bundle; either an absolute path.
@@ -171,18 +171,15 @@ public class JettyBootstrapActivator implements BundleActivator
      * registers it as an OSGi service. The tracker
      * {@link JettyContextHandlerServiceTracker} will do the actual deployment.
      * 
-     * @param context
+     * @param contributor
-     *            The current bundle context
+     *            The bundle
      * @param webappFolderPath
      *            The path to the root of the webapp. Must be a path relative to
      *            bundle; either an absolute path.
      * @param contextPath
      *            The context path. Must start with "/"
-     * @param thisBundleInstallationOverride
+     * @param dic
-     *            The location to a folder where the context file is located
+     *        TODO: parameter description
-     *            This overrides the default behavior that consists of using the
-     *            location where the bundle is installed. Useful when in fact
-     *            the webapp contributed is not inside a bundle.
      * @throws Exception
      */
     public static void registerWebapplication(Bundle contributor, String webappFolderPath, String contextPath, Dictionary<String, String> dic) throws Exception
@@ -220,11 +217,8 @@ public class JettyBootstrapActivator implements BundleActivator
      * @param contextFilePath
      *            The path to the file inside the bundle that defines the
      *            context.
-     * @param thisBundleInstallationOverride
+     * @param dic
-     *            The location to a folder where the context file is located
+     *          TODO: parameter description
-     *            This overrides the default behavior that consists of using the
-     *            location where the bundle is installed. Useful when in fact
-     *            the webapp contributed is not inside a bundle.
      * @throws Exception
      */
     public static void registerContext(Bundle contributor, String contextFilePath, Dictionary<String, String> dic) throws Exception

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/OSGiAppProvider.java

@@ -91,8 +91,6 @@ public class OSGiAppProvider extends ScanningAppProvider implements AppProvider
     /**
      * Default OSGiAppProvider consutructed when none are defined in the
      * jetty.xml configuration.
-     * 
-     * @param contextsDir
      */
     public OSGiAppProvider()
     {

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/internal/jsp/TldLocatableURLClassloaderWithInsertedJettyClassloader.java

@@ -30,7 +30,7 @@ public class TldLocatableURLClassloaderWithInsertedJettyClassloader extends TldL
 
     /**
      * 
-     * @param osgiClassLoader
+     * @param osgiClassLoaderParent
      *            The parent classloader
      * @param internalClassLoader
      *            The classloader that will be at the same level than the

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/internal/webapp/WebappRegistrationHelper.java

@@ -396,17 +396,19 @@ public class WebappRegistrationHelper
     /**
      * Deploy a new web application on the jetty server.
      * 
-     * @param context
+     * @param bundle
-     *            The current bundle context
+     *            The bundle
      * @param webappFolderPath
      *            The path to the root of the webapp. Must be a path relative to
      *            bundle; either an absolute path.
      * @param contextPath
      *            The context path. Must start with "/"
-     * @param classInBundle
+     * @param extraClasspath
-     *            A class that belongs to the current bundle to inherit from the
+     * @param overrideBundleInstallLocation
-     *            osgi classloader. Null to not have access to the OSGI
+     * @param webXmlPath
-     *            classloader.
+     * @param defaultWebXmlPath
+     *            TODO: parameter description
+     * @return The contexthandler created and started
      * @throws Exception
      */
     public ContextHandler registerWebapplication(Bundle bundle, String webappFolderPath, String contextPath, String extraClasspath,
@@ -439,12 +441,16 @@ public class WebappRegistrationHelper
     }
 
     /**
-     * @See {@link WebAppDeployer#scan()}
+     * TODO: refactor this into the createContext method of OSGiAppProvider.
-     * TODO: refacotr this into the createContext method of OSGiAppProvider.
+     * @see WebAppDeployer#scan()
-     * 
+
+     * @param contributor
      * @param webapp
      * @param contextPath
-     * @param classInBundle
+     * @param extraClasspath
+     * @param bundleInstall
+     * @param webXmlPath
+     * @param defaultWebXmlPath
      * @return The contexthandler created and started
      * @throws Exception
      */
@@ -537,7 +543,7 @@ public class WebappRegistrationHelper
     /**
      * Stop a ContextHandler and remove it from the collection.
      * 
-     * @See ContextDeployer#undeploy
+     * @see ContextDeployer#undeploy
      * @param contextHandler
      * @throws Exception
      */
@@ -579,9 +585,11 @@ public class WebappRegistrationHelper
      * Context encompasses jndi and all other things. This makes the definition
      * of the webapp a lot more self-contained.
      * 
-     * @param webapp
+     * @param contributor
-     * @param contextPath
+     * @param contextFileRelativePath
-     * @param classInBundle
+     * @param extraClasspath
+     * @param overrideBundleInstallLocation
+     * @return The contexthandler created and started
      * @throws Exception
      */
     public ContextHandler registerContext(Bundle contributor, String contextFileRelativePath, String extraClasspath, String overrideBundleInstallLocation)

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/BundleFileLocatorHelper.java

@@ -53,7 +53,7 @@ public interface BundleFileLocatorHelper
      * 
      * @param bundle
      * @param path
-     * @return
+     * @return file object
      * @throws Exception
      */
     public File getFileInBundle(Bundle bundle, String path) throws Exception;

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/WebappRegistrationCustomizer.java

@@ -46,7 +46,7 @@ public interface WebappRegistrationCustomizer
      * the root and/or in the lib folder (nice for PDE developement situations)
      * Unsupported: the bundle is a jar that embeds more jars.
      * 
-     * @return
+     * @return array of URLs
      * @throws Exception
      */
     URL[] getJarsWithTlds(OSGiAppProvider provider, BundleFileLocatorHelper fileLocator) throws Exception;

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/internal/DefaultBundleClassLoaderHelper.java

@@ -61,7 +61,7 @@ public class DefaultBundleClassLoaderHelper implements BundleClassLoaderHelper
      * Assuming the bundle is started.
      * 
      * @param bundle
-     * @return
+     * @return classloader object
      */
     public ClassLoader getBundleClassLoader(Bundle bundle)
     {

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/boot/utils/internal/DefaultFileLocatorHelper.java

@@ -145,7 +145,7 @@ public class DefaultFileLocatorHelper implements BundleFileLocatorHelper
      * 
      * @param bundle
      * @param path
-     * @return
+     * @return file object
      * @throws Exception
      */
     public File getFileInBundle(Bundle bundle, String path) throws Exception

jetty-security/src/main/java/org/eclipse/jetty/security/Authenticator.java

@@ -53,10 +53,10 @@ public interface Authenticator
      * @param request The request
      * @param response The response
      * @param mandatory True if authentication is mandatory.
-     * @return An Authentication.  If Authentication is successful, this will be a {@link Authentication.User}. If a response has 
+     * @return An Authentication.  If Authentication is successful, this will be a {@link org.eclipse.jetty.server.Authentication.User}. If a response has 
      * been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will
-     * implement {@link Authentication.ResponseSent}.  If Authentication is not manditory, then a {@link Authentication.Deferred} 
+     * implement {@link org.eclipse.jetty.server.Authentication.ResponseSent}.  If Authentication is not manditory, then a 
-     * may be returned.
+     * {@link org.eclipse.jetty.server.Authentication.Deferred} may be returned.
      * 
      * @throws ServerAuthException
      */

jetty-security/src/main/java/org/eclipse/jetty/security/DefaultIdentityService.java

@@ -24,9 +24,10 @@ import org.eclipse.jetty.server.UserIdentity;
 /**
  * Default Identity Service implementation.
  * This service handles only role reference maps passed in an
- * associated {@link UserIdentity.Scope}.  If there are roles
+ * associated {@link org.eclipse.jetty.server.UserIdentity.Scope}.  If there are roles
  * refs present, then associate will wrap the UserIdentity with one
- * that uses the role references in the {@link UserIdentity#isUserInRole(String, org.eclipse.jetty.server.UserIdentity.Scope)}
+ * that uses the role references in the 
+ * {@link org.eclipse.jetty.server.UserIdentity#isUserInRole(String, org.eclipse.jetty.server.UserIdentity.Scope)}
  * implementation. All other operations are effectively noops.
  *
  */

jetty-server/src/main/java/org/eclipse/jetty/server/Request.java

@@ -1550,7 +1550,9 @@ public class Request implements HttpServletRequest
 
     /* ------------------------------------------------------------ */
     /**
-     * @param context
+     * Set request context
+     * 
+     * @param context context object
      */
     public void setContext(Context context)
     {
@@ -1560,7 +1562,8 @@ public class Request implements HttpServletRequest
     
     /* ------------------------------------------------------------ */
     /**
-     * @return True if this is the first call of {@link #takeNewContext()} since the last {@link #setContext(Context)} call.
+     * @return True if this is the first call of {@link #takeNewContext()} 
+     * since the last {@link #setContext(org.eclipse.jetty.server.handler.ContextHandler.Context)} call.
      */
     public boolean takeNewContext()
     {

jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java

@@ -667,7 +667,7 @@ public class SslSocketConnector extends SocketConnector  implements SslConnector
     /**
      * Unsupported.
      * 
-     * @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
+     * TODO: we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
      */
     public String getAlgorithm()
     {
@@ -678,7 +678,7 @@ public class SslSocketConnector extends SocketConnector  implements SslConnector
     /**
      * Unsupported.
      * 
-     * @todo we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
+     * TODO: we should remove this as it is no longer an overridden method from SslConnector (like it was in the past)
      */
     public void setAlgorithm(String algorithm)
     {

jetty-webapp/src/main/java/org/eclipse/jetty/webapp/ClasspathPattern.java

@@ -58,7 +58,7 @@ public class ClasspathPattern
      * Create a new instance from a String array of classpath patterns
      * 
      * @param patterns array of classpath patterns
-     * @return
+     * @return new instance
      */
     public static ClasspathPattern fromArray(String[] patterns)
     {
@@ -70,7 +70,7 @@ public class ClasspathPattern
      * Create a new instance from a classpath pattern sring
      * 
      * @param patterns classpath pattern string
-     * @return
+     * @return new instance
      */
     public static ClasspathPattern fromString(String patterns)
     {

pom.xml

@@ -353,6 +353,13 @@
                 <link>http://java.sun.com/javaee/5/docs/api</link>
                 <link>http://junit.sourceforge.net/javadoc/</link>
               </links>
+              <tags>
+                <tag>
+                  <name>org.apache.xbean.XBean</name>
+                  <placement>x</placement>
+                  <head></head>
+                </tag>
+              </tags>
             </configuration>
           </plugin>
         </plugins>