Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoakim Erdfelt2015-04-22 19:13:45 +0000
committerJoakim Erdfelt2015-04-22 19:13:45 +0000
commit4f3b4c5d3b3a1de91906c046c4877b5ef0f6b923 (patch)
tree12a5dc262d79f8672670001d834eff85e7d79796 /jetty-ant/src/main
parentcffeea3ed6097d528b61db9378394bad7304a26d (diff)
downloadorg.eclipse.jetty.project-4f3b4c5d3b3a1de91906c046c4877b5ef0f6b923.tar.gz
org.eclipse.jetty.project-4f3b4c5d3b3a1de91906c046c4877b5ef0f6b923.tar.xz
org.eclipse.jetty.project-4f3b4c5d3b3a1de91906c046c4877b5ef0f6b923.zip
464727 - Update Javadoc for Java 8 DocLint
+ Fixing javadoc in jetty-ant
Diffstat (limited to 'jetty-ant/src/main')
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/AntWebAppContext.java8
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/JettyRunTask.java33
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/types/Connectors.java6
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/types/ContextHandlers.java3
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/types/FileMatchingConfiguration.java5
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/types/LoginServices.java6
-rw-r--r--jetty-ant/src/main/java/org/eclipse/jetty/ant/types/SystemProperties.java9
7 files changed, 14 insertions, 56 deletions
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/AntWebAppContext.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/AntWebAppContext.java
index a8752b3f5c..7512581eb4 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/AntWebAppContext.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/AntWebAppContext.java
@@ -16,7 +16,6 @@
// ========================================================================
//
-
package org.eclipse.jetty.ant;
import java.io.File;
@@ -67,13 +66,8 @@ import org.eclipse.jetty.webapp.WebInfConfiguration;
import org.eclipse.jetty.webapp.WebXmlConfiguration;
import org.eclipse.jetty.xml.XmlConfiguration;
-
-
/**
- * AntWebAppContext
- *
* Extension of WebAppContext to allow configuration via Ant environment.
- *
*/
public class AntWebAppContext extends WebAppContext
{
@@ -432,6 +426,7 @@ public class AntWebAppContext extends WebAppContext
* Default constructor. Takes project as an argument
*
* @param project the project.
+ * @throws Exception if unable to create webapp context
*/
public AntWebAppContext(Project project) throws Exception
{
@@ -445,6 +440,7 @@ public class AntWebAppContext extends WebAppContext
/**
* Adds a new Ant's attributes tag object if it have not been created yet.
+ * @param atts the attributes
*/
public void addAttributes(Attributes atts)
{
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/JettyRunTask.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/JettyRunTask.java
index 626ea4dfed..cc2cb49fcd 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/JettyRunTask.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/JettyRunTask.java
@@ -41,10 +41,8 @@ import org.eclipse.jetty.webapp.WebAppContext;
*/
public class JettyRunTask extends Task
{
-
private int scanIntervalSeconds;
-
/** Temporary files directory. */
private File tempDirectory;
@@ -79,9 +77,6 @@ public class JettyRunTask extends Task
private boolean daemon;
-
-
-
public JettyRunTask()
{
TaskLog.setTask(this);
@@ -89,17 +84,16 @@ public class JettyRunTask extends Task
/**
* Creates a new <code>WebApp</code> Ant object.
- *
+ * @param webapp the webapp context
*/
public void addWebApp(AntWebAppContext webapp)
{
webapps.add(webapp);
}
-
-
/**
* Adds a new Ant's connector tag object if it have not been created yet.
+ * @param connectors the connectors
*/
public void addConnectors(Connectors connectors)
{
@@ -108,10 +102,6 @@ public class JettyRunTask extends Task
this.connectors = connectors;
}
-
- /**
- * @param services
- */
public void addLoginServices(LoginServices services)
{
if (this.loginServices != null )
@@ -126,9 +116,6 @@ public class JettyRunTask extends Task
this.systemProperties = systemProperties;
}
- /**
- * @param handlers
- */
public void addContextHandlers (ContextHandlers handlers)
{
if (this.contextHandlers != null)
@@ -141,9 +128,6 @@ public class JettyRunTask extends Task
return tempDirectory;
}
- /**
- * @param tempDirectory
- */
public void setTempDirectory(File tempDirectory)
{
this.tempDirectory = tempDirectory;
@@ -154,17 +138,11 @@ public class JettyRunTask extends Task
return jettyXml;
}
- /**
- * @param jettyXml
- */
public void setJettyXml(File jettyXml)
{
this.jettyXml = jettyXml;
}
- /**
- * @param className
- */
public void setRequestLog(String className)
{
try
@@ -209,7 +187,7 @@ public class JettyRunTask extends Task
* Executes this Ant task. The build flow is being stopped until Jetty
* server stops.
*
- * @throws BuildException
+ * @throws BuildException if unable to build
*/
public void execute() throws BuildException
{
@@ -297,17 +275,12 @@ public class JettyRunTask extends Task
return scanIntervalSeconds;
}
- /**
- * @param secs
- */
public void setScanIntervalSeconds(int secs)
{
scanIntervalSeconds = secs;
TaskLog.log("scanIntervalSecs="+secs);
}
-
-
/**
* Sets the system properties.
*/
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/Connectors.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/Connectors.java
index 9c425e1e81..6b25db15f4 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/Connectors.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/Connectors.java
@@ -23,11 +23,7 @@ import java.util.ArrayList;
import java.util.List;
/**
- *
- * Connectors
- *
- * Specifies a jetty configuration <connectors/> element for Ant build file.
- *
+ * Specifies a jetty configuration <code>&lt;connectors/&gt;</code> element for Ant build file.
*/
public class Connectors
{
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/ContextHandlers.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/ContextHandlers.java
index bfbf49d8ff..0c250583d2 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/ContextHandlers.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/ContextHandlers.java
@@ -25,8 +25,7 @@ import java.util.List;
import org.eclipse.jetty.server.handler.ContextHandler;
/**
- * Specifies <contextHandlers/> element in web app configuration.
- *
+ * Specifies <code>&lt;contextHandlers/&gt;</code> element in web app configuration.
*/
public class ContextHandlers
{
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/FileMatchingConfiguration.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/FileMatchingConfiguration.java
index 5576780e8a..73749f9841 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/FileMatchingConfiguration.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/FileMatchingConfiguration.java
@@ -27,10 +27,9 @@ import java.util.List;
import org.apache.tools.ant.DirectoryScanner;
/**
- * Describes set of files matched by <fileset/> elements in ant configuration
+ * Describes set of files matched by <code>&lt;fileset/&gt;</code> elements in ant configuration
* file. It is used to group application classes, libraries, and scannedTargets
* elements.
- *
*/
public class FileMatchingConfiguration
{
@@ -44,7 +43,7 @@ public class FileMatchingConfiguration
/**
* @param directoryScanner new directory scanner retrieved from the
- * <fileset/> element.
+ * <code>&lt;fileset/&gt;</code> element.
*/
public void addDirectoryScanner(DirectoryScanner directoryScanner)
{
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/LoginServices.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/LoginServices.java
index f83a1d75f3..867f99bca3 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/LoginServices.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/LoginServices.java
@@ -25,14 +25,10 @@ import java.util.List;
import org.eclipse.jetty.security.LoginService;
/**
- * LoginServices
- *
- * Specifies a jetty configuration <loginServices/> element for Ant build file.
- *
+ * Specifies a jetty configuration &lt;loginServices/&gt; element for Ant build file.
*/
public class LoginServices
{
-
private List<LoginService> loginServices = new ArrayList<LoginService>();
public void add(LoginService service)
diff --git a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/SystemProperties.java b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/SystemProperties.java
index 72bed6497e..3e2b38bbdc 100644
--- a/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/SystemProperties.java
+++ b/jetty-ant/src/main/java/org/eclipse/jetty/ant/types/SystemProperties.java
@@ -27,9 +27,8 @@ import org.eclipse.jetty.ant.utils.TaskLog;
/**
* SystemProperties
- *
- * Ant <systemProperties/> tag definition.
- *
+ * <p>
+ * Ant &lt;systemProperties/&gt; tag definition.
*/
public class SystemProperties
{
@@ -48,8 +47,8 @@ public class SystemProperties
/**
* Set a System.property with this value if it is not already set.
- *
- * @returns true if property has been set
+ * @param property the property to test
+ * @return true if property has been set
*/
public static boolean setIfNotSetAlready(Property property)
{

Back to the top