You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by fs...@apache.org on 2015/10/14 18:49:29 UTC
svn commit: r1708649 - in /tomcat/trunk/java/org/apache/catalina: Role.java
Server.java Service.java
Author: fschumacher
Date: Wed Oct 14 16:49:29 2015
New Revision: 1708649
URL: http://svn.apache.org/viewvc?rev=1708649&view=rev
Log:
javadoc: Use real @return tags instead of textual
description, only. Add missing @param tags.
Modified:
tomcat/trunk/java/org/apache/catalina/Role.java
tomcat/trunk/java/org/apache/catalina/Server.java
tomcat/trunk/java/org/apache/catalina/Service.java
Modified: tomcat/trunk/java/org/apache/catalina/Role.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Role.java?rev=1708649&r1=1708648&r2=1708649&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Role.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Role.java Wed Oct 14 16:49:29 2015
@@ -36,7 +36,7 @@ public interface Role extends Principal
/**
- * Return the description of this role.
+ * @return the description of this role.
*/
public String getDescription();
@@ -50,7 +50,7 @@ public interface Role extends Principal
/**
- * Return the role name of this role, which must be unique
+ * @return the role name of this role, which must be unique
* within the scope of a {@link UserDatabase}.
*/
public String getRolename();
@@ -66,7 +66,7 @@ public interface Role extends Principal
/**
- * Return the {@link UserDatabase} within which this Role is defined.
+ * @return the {@link UserDatabase} within which this Role is defined.
*/
public UserDatabase getUserDatabase();
Modified: tomcat/trunk/java/org/apache/catalina/Server.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Server.java?rev=1708649&r1=1708648&r2=1708649&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Server.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Server.java Wed Oct 14 16:49:29 2015
@@ -51,7 +51,7 @@ public interface Server extends Lifecycl
// ------------------------------------------------------------- Properties
/**
- * Return the global naming resources.
+ * @return the global naming resources.
*/
public NamingResourcesImpl getGlobalNamingResources();
@@ -66,13 +66,13 @@ public interface Server extends Lifecycl
/**
- * Return the global naming resources context.
+ * @return the global naming resources context.
*/
public javax.naming.Context getGlobalNamingContext();
/**
- * Return the port number we listen to for shutdown commands.
+ * @return the port number we listen to for shutdown commands.
*/
public int getPort();
@@ -86,7 +86,7 @@ public interface Server extends Lifecycl
/**
- * Return the address on which we listen to for shutdown commands.
+ * @return the address on which we listen to for shutdown commands.
*/
public String getAddress();
@@ -100,7 +100,7 @@ public interface Server extends Lifecycl
/**
- * Return the shutdown command string we are waiting for.
+ * @return the shutdown command string we are waiting for.
*/
public String getShutdown();
@@ -114,7 +114,7 @@ public interface Server extends Lifecycl
/**
- * Return the parent class loader for this component. If not set, return
+ * @return the parent class loader for this component. If not set, return
* {@link #getCatalina()} {@link Catalina#getParentClassLoader()}. If
* catalina has not been set, return the system class loader.
*/
@@ -130,18 +130,20 @@ public interface Server extends Lifecycl
/**
- * Return the outer Catalina startup/shutdown component if present.
+ * @return the outer Catalina startup/shutdown component if present.
*/
public Catalina getCatalina();
/**
* Set the outer Catalina startup/shutdown component if present.
+ *
+ * @param catalina the outer Catalina component
*/
public void setCatalina(Catalina catalina);
/**
- * Obtain the configured base (instance) directory. Note that home and base
+ * @return the configured base (instance) directory. Note that home and base
* may be the same (and are by default). If this is not set the value
* returned by {@link #getCatalinaHome()} will be used.
*/
@@ -150,12 +152,14 @@ public interface Server extends Lifecycl
/**
* Set the configured base (instance) directory. Note that home and base
* may be the same (and are by default).
+ *
+ * @param catalinaBase the configured base directory
*/
public void setCatalinaBase(File catalinaBase);
/**
- * Obtain the configured home (binary) directory. Note that home and base
+ * @return the configured home (binary) directory. Note that home and base
* may be the same (and are by default).
*/
public File getCatalinaHome();
@@ -163,6 +167,8 @@ public interface Server extends Lifecycl
/**
* Set the configured home (binary) directory. Note that home and base
* may be the same (and are by default).
+ *
+ * @param catalinaHome the configured home directory
*/
public void setCatalinaHome(File catalinaHome);
@@ -185,16 +191,16 @@ public interface Server extends Lifecycl
/**
- * Return the specified Service (if it exists); otherwise return
- * <code>null</code>.
+ * Find the specified Service
*
* @param name Name of the Service to be returned
+ * @return the specified Service, or <code>null</code> if none exists.
*/
public Service findService(String name);
/**
- * Return the set of Services defined within this Server.
+ * @return the set of Services defined within this Server.
*/
public Service[] findServices();
@@ -209,7 +215,7 @@ public interface Server extends Lifecycl
/**
- * Obtain the token necessary for operations on the associated JNDI naming
+ * @return the token necessary for operations on the associated JNDI naming
* context.
*/
public Object getNamingToken();
Modified: tomcat/trunk/java/org/apache/catalina/Service.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Service.java?rev=1708649&r1=1708648&r2=1708649&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Service.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Service.java Wed Oct 14 16:49:29 2015
@@ -39,7 +39,7 @@ public interface Service extends Lifecyc
/**
- * Return the <code>Container</code> that handles requests for all
+ * @return the <code>Container</code> that handles requests for all
* <code>Connectors</code> associated with this Service.
*/
public Container getContainer();
@@ -53,7 +53,7 @@ public interface Service extends Lifecyc
public void setContainer(Container container);
/**
- * Return the name of this Service.
+ * @return the name of this Service.
*/
public String getName();
@@ -65,7 +65,7 @@ public interface Service extends Lifecyc
public void setName(String name);
/**
- * Return the <code>Server</code> with which we are associated (if any).
+ * @return the <code>Server</code> with which we are associated (if any).
*/
public Server getServer();
@@ -77,7 +77,7 @@ public interface Service extends Lifecyc
public void setServer(Server server);
/**
- * Return the parent class loader for this component. If not set, return
+ * @return the parent class loader for this component. If not set, return
* {@link #getServer()} {@link Server#getParentClassLoader()}. If no server
* has been set, return the system class loader.
*/
@@ -91,7 +91,7 @@ public interface Service extends Lifecyc
public void setParentClassLoader(ClassLoader parent);
/**
- * Obtain the domain under which this container will be / has been
+ * @return the domain under which this container will be / has been
* registered.
*/
public String getDomain();
@@ -109,6 +109,8 @@ public interface Service extends Lifecyc
/**
* Find and return the set of Connectors associated with this Service.
+ *
+ * @return the set of associated Connectors
*/
public Connector[] findConnectors();
@@ -147,7 +149,7 @@ public interface Service extends Lifecyc
public void removeExecutor(Executor ex);
/**
- * The mapper associated with this Service.
+ * @return the mapper associated with this Service.
*/
Mapper getMapper();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org