Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoakim Erdfelt2015-04-22 19:54:50 -0400
committerJoakim Erdfelt2015-04-22 19:54:50 -0400
commit4db27843542211c57746438c328b32c0f1f69e81 (patch)
treef1cf1453535fc250487916fbca37470e09a7085a /jetty-quickstart
parent18a1096412530047f1a7102a5af54ab69767d351 (diff)
downloadorg.eclipse.jetty.project-4db27843542211c57746438c328b32c0f1f69e81.tar.gz
org.eclipse.jetty.project-4db27843542211c57746438c328b32c0f1f69e81.tar.xz
org.eclipse.jetty.project-4db27843542211c57746438c328b32c0f1f69e81.zip
464727 - Update Javadoc for Java 8 DocLint
Diffstat (limited to 'jetty-quickstart')
-rw-r--r--jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java3
-rw-r--r--jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java9
-rw-r--r--jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java16
-rw-r--r--jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java9
4 files changed, 12 insertions, 25 deletions
diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java
index 134f423d9e..5a22dd35ee 100644
--- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java
+++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/PreconfigureQuickStartWar.java
@@ -30,7 +30,6 @@ public class PreconfigureQuickStartWar
private static final Logger LOG = Log.getLogger(PreconfigureQuickStartWar.class);
static final boolean ORIGIN=LOG.isDebugEnabled();
-
public static void main(String... args) throws Exception
{
Resource war = null;
@@ -80,7 +79,7 @@ public class PreconfigureQuickStartWar
* @param war The war (or directory) to preconfigure
* @param dir The directory to expand the war into (or null if war is a directory)
* @param xml A context XML to apply (or null if none)
- * @throws Exception
+ * @throws Exception if unable to pre configure
*/
public static void preconfigure(Resource war, Resource dir, Resource xml) throws Exception
{
diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java
index 7dceb10dd4..c82ce144f8 100644
--- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java
+++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartConfiguration.java
@@ -31,10 +31,9 @@ import org.eclipse.jetty.webapp.WebInfConfiguration;
/**
* QuickStartConfiguration
- *
+ * <p>
* Re-inflate a deployable webapp from a saved effective-web.xml
* which combines all pre-parsed web xml descriptors and annotations.
- *
*/
public class QuickStartConfiguration extends WebInfConfiguration
{
@@ -83,9 +82,9 @@ public class QuickStartConfiguration extends WebInfConfiguration
/**
* Get the quickstart-web.xml file as a Resource.
*
- * @param context
- * @return
- * @throws Exception
+ * @param context the web app context
+ * @return the Resource for the quickstart-web.xml
+ * @throws Exception if unable to find the quickstart xml
*/
public Resource getQuickStartWebXml (WebAppContext context) throws Exception
{
diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java
index 3a7cee9626..9df1c37c9b 100644
--- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java
+++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorGenerator.java
@@ -62,11 +62,9 @@ import org.eclipse.jetty.webapp.MetaInfConfiguration;
import org.eclipse.jetty.webapp.WebAppContext;
import org.eclipse.jetty.xml.XmlAppendable;
-
-
/**
* QuickStartDescriptorGenerator
- *
+ * <p>
* Generate an effective web.xml from a WebAppContext, including all components
* from web.xml, web-fragment.xmls annotations etc.
*/
@@ -94,9 +92,9 @@ public class QuickStartDescriptorGenerator
/**
* Perform the generation of the xml file
- * @throws IOException
- * @throws FileNotFoundException
- * @throws Exception
+ * @param stream the stream to generate the quickstart-web.xml to
+ * @throws IOException if unable to generate the quickstart-web.xml
+ * @throws FileNotFoundException if unable to find the file
*/
public void generateQuickStartWebXml (OutputStream stream) throws FileNotFoundException, IOException
{
@@ -668,9 +666,9 @@ public class QuickStartDescriptorGenerator
/**
* Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData.
*
- * @param md
- * @param name
- * @return
+ * @param md the metadata
+ * @param name the name
+ * @return the origin map
*/
public Map<String, String> origin(MetaData md, String name)
{
diff --git a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java
index 43a0c2e9b1..2c56af43aa 100644
--- a/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java
+++ b/jetty-quickstart/src/main/java/org/eclipse/jetty/quickstart/QuickStartDescriptorProcessor.java
@@ -44,9 +44,6 @@ import org.eclipse.jetty.xml.XmlParser;
*/
public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor
{
- /**
- *
- */
public QuickStartDescriptorProcessor()
{
try
@@ -74,13 +71,7 @@ public class QuickStartDescriptorProcessor extends IterativeDescriptorProcessor
public void end(WebAppContext context, Descriptor descriptor)
{
}
-
- /**
- * @param context
- * @param descriptor
- * @param node
- */
public void visitContextParam (WebAppContext context, Descriptor descriptor, XmlParser.Node node)
throws Exception
{

Back to the top