Javadoc enhancements for JSP 2.0 API.
New Files (attached separately):
- jsr152/src/share/javax/servlet/jsp/package.html
- jsr152/src/share/javax/servlet/jsp/el/package.html
- jsr152/src/share/javax/servlet/jsp/tagext/package.html
jsr152/src/share/javax/servlet/jsp/JspContext.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/JspEngineInfo.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/JspFactory.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/PageContext.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/tagext/BodyTag.java
- Added description for doInitBody() @throws JspException
jsr152/src/share/javax/servlet/jsp/tagext/IterationTag.java
- Added description for doAfterBody() @throws JspException
jsr152/src/share/javax/servlet/jsp/tagext/PageData.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/tagext/SimpleTagSupport.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/tagext/TagExtraInfo.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/tagext/TagLibraryValidator.java
- Added javadoc comment for public no-args constructor
jsr152/src/share/javax/servlet/jsp/tagext/TryCatchFinally.java
- Added @throws Throwable tag for doCatch()
---
Mark Roth, Java Software
JSP 2.0 Co-Specification Lead
Sun Microsystems, Inc.
Index: jsr152/src/share/javax/servlet/jsp/JspContext.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/JspContext.java,v
retrieving revision 1.6
diff -u -r1.6 JspContext.java
--- jsr152/src/share/javax/servlet/jsp/JspContext.java 18 Dec 2002 18:35:37 -0000
1.6
+++ jsr152/src/share/javax/servlet/jsp/JspContext.java 29 Jan 2003 21:01:27 -0000
@@ -109,6 +109,13 @@
public abstract class JspContext {
+ /**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public JspContext() {
+ }
+
/**
* Register the name and value specified with page scope semantics.
* If the value passed in is <code>null</code>, this has the same
Index: jsr152/src/share/javax/servlet/jsp/JspEngineInfo.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/JspEngineInfo.java,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 JspEngineInfo.java
--- jsr152/src/share/javax/servlet/jsp/JspEngineInfo.java 13 Aug 2002 16:20:54
-0000 1.1.1.1
+++ jsr152/src/share/javax/servlet/jsp/JspEngineInfo.java 29 Jan 2003 21:01:27
+-0000
@@ -61,6 +61,13 @@
*/
public abstract class JspEngineInfo {
+
+ /**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public JspEngineInfo() {
+ }
/**
* Return the version number of the JSP specification that is supported by
Index: jsr152/src/share/javax/servlet/jsp/JspFactory.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/JspFactory.java,v
retrieving revision 1.2
diff -u -r1.2 JspFactory.java
--- jsr152/src/share/javax/servlet/jsp/JspFactory.java 19 Aug 2002 16:29:49 -0000
1.2
+++ jsr152/src/share/javax/servlet/jsp/JspFactory.java 29 Jan 2003 21:01:27 -0000
@@ -82,6 +82,13 @@
public abstract class JspFactory {
private static JspFactory deflt = null;
+
+ /**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public JspFactory() {
+ }
/**
* <p>
Index: jsr152/src/share/javax/servlet/jsp/PageContext.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/PageContext.java,v
retrieving revision 1.6
diff -u -r1.6 PageContext.java
--- jsr152/src/share/javax/servlet/jsp/PageContext.java 18 Dec 2002 18:35:37 -0000
1.6
+++ jsr152/src/share/javax/servlet/jsp/PageContext.java 29 Jan 2003 21:01:28 -0000
@@ -132,7 +132,14 @@
abstract public class PageContext
extends JspContext
{
-
+
+ /**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public PageContext() {
+ }
+
/**
* Page scope: (this is the default) the named reference remains available
* in this PageContext until the return from the current Servlet.service()
Index: jsr152/src/share/javax/servlet/jsp/tagext/BodyTag.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/BodyTag.java,v
retrieving revision 1.5
diff -u -r1.5 BodyTag.java
--- jsr152/src/share/javax/servlet/jsp/tagext/BodyTag.java 16 Jan 2003 01:37:04
-0000 1.5
+++ jsr152/src/share/javax/servlet/jsp/tagext/BodyTag.java 29 Jan 2003 21:01:28
+-0000
@@ -214,7 +214,7 @@
* NESTED variables (defined by the associated TagExtraInfo or TLD) after
* the invocation of doInitBody().
*
- * @throws JspException
+ * @throws JspException if an error occurred while processing this tag
* @see #doAfterBody
*/
Index: jsr152/src/share/javax/servlet/jsp/tagext/IterationTag.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/IterationTag.java,v
retrieving revision 1.4
diff -u -r1.4 IterationTag.java
--- jsr152/src/share/javax/servlet/jsp/tagext/IterationTag.java 18 Dec 2002 18:35:37
-0000 1.4
+++ jsr152/src/share/javax/servlet/jsp/tagext/IterationTag.java 29 Jan 2003 21:01:28
+-0000
@@ -147,7 +147,7 @@
* the invocation of doAfterBody().
*
* @return whether additional evaluations of the body are desired
- * @throws JspException
+ * @throws JspException if an error occurred while processing this tag
*/
int doAfterBody() throws JspException;
Index: jsr152/src/share/javax/servlet/jsp/tagext/PageData.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/PageData.java,v
retrieving revision 1.2
diff -u -r1.2 PageData.java
--- jsr152/src/share/javax/servlet/jsp/tagext/PageData.java 8 Nov 2002 21:30:21
-0000 1.2
+++ jsr152/src/share/javax/servlet/jsp/tagext/PageData.java 29 Jan 2003 21:01:28
+-0000
@@ -69,6 +69,13 @@
abstract public class PageData {
/**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public PageData() {
+ }
+
+ /**
* Returns an input stream on the XML view of a JSP page.
* The stream is encoded in UTF-8. Recall tht the XML view of a
* JSP page has the include directives expanded.
Index: jsr152/src/share/javax/servlet/jsp/tagext/SimpleTagSupport.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/SimpleTagSupport.java,v
retrieving revision 1.4
diff -u -r1.4 SimpleTagSupport.java
--- jsr152/src/share/javax/servlet/jsp/tagext/SimpleTagSupport.java 29 Oct 2002
01:18:12 -0000 1.4
+++ jsr152/src/share/javax/servlet/jsp/tagext/SimpleTagSupport.java 29 Jan 2003
+21:01:28 -0000
@@ -81,6 +81,13 @@
/** The body of the tag. */
protected JspFragment jspBody;
+ /**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public SimpleTagSupport() {
+ }
+
/**
* Default processing of the tag does nothing.
*
Index: jsr152/src/share/javax/servlet/jsp/tagext/TagExtraInfo.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/TagExtraInfo.java,v
retrieving revision 1.4
diff -u -r1.4 TagExtraInfo.java
--- jsr152/src/share/javax/servlet/jsp/tagext/TagExtraInfo.java 4 Nov 2002 17:44:24
-0000 1.4
+++ jsr152/src/share/javax/servlet/jsp/tagext/TagExtraInfo.java 29 Jan 2003 21:01:29
+-0000
@@ -92,6 +92,13 @@
public abstract class TagExtraInfo {
/**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public TagExtraInfo() {
+ }
+
+ /**
* information on scripting variables defined by the tag associated with
* this TagExtraInfo instance.
* Request-time attributes are indicated as such in the TagData parameter.
Index: jsr152/src/share/javax/servlet/jsp/tagext/TagLibraryValidator.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/TagLibraryValidator.java,v
retrieving revision 1.4
diff -u -r1.4 TagLibraryValidator.java
--- jsr152/src/share/javax/servlet/jsp/tagext/TagLibraryValidator.java 18 Dec 2002
18:35:37 -0000 1.4
+++ jsr152/src/share/javax/servlet/jsp/tagext/TagLibraryValidator.java 29 Jan 2003
+21:01:29 -0000
@@ -106,6 +106,13 @@
abstract public class TagLibraryValidator {
/**
+ * Sole constructor. (For invocation by subclass constructors,
+ * typically implicit.)
+ */
+ public TagLibraryValidator() {
+ }
+
+ /**
* Set the init data in the TLD for this validator.
* Parameter names are keys, and parameter values are the values.
*
@@ -150,7 +157,7 @@
*/
public void release() {
initParameters = null;
- };
+ }
// Private data
private Map initParameters;
Index: jsr152/src/share/javax/servlet/jsp/tagext/TryCatchFinally.java
===================================================================
RCS file:
/home/cvspublic/jakarta-servletapi-5/jsr152/src/share/javax/servlet/jsp/tagext/TryCatchFinally.java,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 TryCatchFinally.java
--- jsr152/src/share/javax/servlet/jsp/tagext/TryCatchFinally.java 13 Aug 2002
16:20:56 -0000 1.1.1.1
+++ jsr152/src/share/javax/servlet/jsp/tagext/TryCatchFinally.java 29 Jan 2003
+21:01:29 -0000
@@ -103,13 +103,15 @@
* one of the setter methods.
*
* <p>This method may throw an exception (the same or a new one)
- * that will be propagated further the nest chain. If an exception
+ * that will be propagated further up the nest chain. If an exception
* is thrown, doFinally() will be invoked.
*
* <p>This method is intended to be used to respond to an exceptional
* condition.
*
* @param t The throwable exception navigating through this tag.
+ * @throws Throwable if the exception is to be rethrown further up
+ * the nest chain.
*/
void doCatch(Throwable t) throws Throwable;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
