464727 - Update Javadoc for Java 8 DocLint

+ Fixing javadoc in jetty-ant
This commit is contained in:
Joakim Erdfelt 2015-04-22 12:13:45 -07:00
parent cffeea3ed6
commit 4f3b4c5d3b
7 changed files with 14 additions and 56 deletions

View File

@ -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)
{

View File

@ -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.
*/

View File

@ -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
{

View File

@ -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
{

View File

@ -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)
{

View File

@ -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)

View File

@ -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)
{