Author: markt
Date: Tue Oct 14 15:42:24 2014
New Revision: 1631798
URL: http://svn.apache.org/r1631798
Log:
Start the long process of fixing the Java 8 Javadoc warnings for the non-API
packages.
Modified:
tomcat/trunk/java/org/apache/catalina/AsyncDispatcher.java
tomcat/trunk/java/org/apache/catalina/Authenticator.java
tomcat/trunk/java/org/apache/catalina/Cluster.java
tomcat/trunk/java/org/apache/catalina/Contained.java
Modified: tomcat/trunk/java/org/apache/catalina/AsyncDispatcher.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/AsyncDispatcher.java?rev=1631798&r1=1631797&r2=1631798&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/AsyncDispatcher.java (original)
+++ tomcat/trunk/java/org/apache/catalina/AsyncDispatcher.java Tue Oct 14
15:42:24 2014
@@ -28,6 +28,11 @@ public interface AsyncDispatcher {
* Perform an asynchronous dispatch. The method does not check if the
* request is in an appropriate state for this; it is the caller's
* responsibility to check this.
+ * @param request The request object to pass to the dispatch target
+ * @param response The response object to pass to the dispatch target
+ * @throws ServletException if thrown by the dispatch target
+ * @throws IOException if an I/O error occurs while processing the
+ * dispatch
*/
public void dispatch(ServletRequest request, ServletResponse response)
throws ServletException, IOException;
Modified: tomcat/trunk/java/org/apache/catalina/Authenticator.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Authenticator.java?rev=1631798&r1=1631797&r2=1631798&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Authenticator.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Authenticator.java Tue Oct 14
15:42:24 2014
@@ -35,13 +35,16 @@ public interface Authenticator {
/**
* Authenticate the user making this request, based on the login
* configuration of the {@link Context} with which this Authenticator is
- * associated. Return <code>true</code> if any specified constraint has
- * been satisfied, or <code>false</code> if we have created a response
- * challenge already.
+ * associated.
*
* @param request Request we are processing
* @param response Response we are populating
*
+ * @return <code>true</code> if any specified constraints have been
+ * satisfied, or <code>false</code> if one more constraints were
not
+ * satisfied (in which case an authentication challenge will have
+ * been written to the response).
+ *
* @exception IOException if an input/output error occurs
*/
public boolean authenticate(Request request, HttpServletResponse response)
Modified: tomcat/trunk/java/org/apache/catalina/Cluster.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Cluster.java?rev=1631798&r1=1631797&r2=1631798&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Cluster.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Cluster.java Tue Oct 14 15:42:24 2014
@@ -72,6 +72,8 @@ public interface Cluster {
*
* @param name Name (key) of the application with which the manager is
* associated
+ *
+ * @return The newly created Manager instance
*/
public Manager createManager(String name);
Modified: tomcat/trunk/java/org/apache/catalina/Contained.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Contained.java?rev=1631798&r1=1631797&r2=1631798&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Contained.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Contained.java Tue Oct 14 15:42:24
2014
@@ -14,11 +14,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.catalina;
-
/**
* <p>Decoupling interface which specifies that an implementing class is
* associated with at most one <strong>Container</strong> instance.</p>
@@ -28,15 +25,13 @@ package org.apache.catalina;
*/
public interface Contained {
-
- //-------------------------------------------------------------- Properties
-
-
/**
- * Return the <code>Container</code> with which this instance is associated
- * (if any); otherwise return <code>null</code>.
+ * Get the {@link Container} with which this instance is associated.
+ *
+ * @return The Container with which this instance is associated or
+ * <code>null</code> if not associated with a Container
*/
- public Container getContainer();
+ Container getContainer();
/**
@@ -46,7 +41,5 @@ public interface Contained {
* be associated, or <code>null</code> to disassociate this instance
* from any Container
*/
- public void setContainer(Container container);
-
-
+ void setContainer(Container container);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
