You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2020/02/10 16:41:22 UTC
[tomcat] branch 7.0.x updated: A few more Javadoc fixes for newer
versions of Java
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/7.0.x by this push:
new c8c87f2 A few more Javadoc fixes for newer versions of Java
c8c87f2 is described below
commit c8c87f2b90c367bee407f24ffc98e7c70d18b7c4
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Feb 6 14:58:53 2020 +0000
A few more Javadoc fixes for newer versions of Java
---
java/org/apache/jasper/compiler/ErrorHandler.java | 4 ++++
java/org/apache/jasper/compiler/JarResource.java | 4 ++--
java/org/apache/jasper/compiler/JarScannerFactory.java | 2 ++
java/org/apache/jasper/compiler/JspConfig.java | 4 ++++
java/org/apache/jasper/compiler/JspUtil.java | 7 +++++++
java/org/apache/jasper/runtime/PageContextImpl.java | 2 ++
6 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/java/org/apache/jasper/compiler/ErrorHandler.java b/java/org/apache/jasper/compiler/ErrorHandler.java
index 8b2f028..5d069f0 100644
--- a/java/org/apache/jasper/compiler/ErrorHandler.java
+++ b/java/org/apache/jasper/compiler/ErrorHandler.java
@@ -40,6 +40,7 @@ public interface ErrorHandler {
* @param column Parse error column number
* @param msg Parse error message
* @param exception Parse exception
+ * @throws JasperException An error occurred
*/
public void jspError(String fname, int line, int column, String msg,
Exception exception) throws JasperException;
@@ -49,6 +50,7 @@ public interface ErrorHandler {
*
* @param msg Parse error message
* @param exception Parse exception
+ * @throws JasperException An error occurred
*/
public void jspError(String msg, Exception exception)
throws JasperException;
@@ -58,6 +60,7 @@ public interface ErrorHandler {
*
* @param details Array of JavacErrorDetail instances corresponding to the
* compilation errors
+ * @throws JasperException An error occurred
*/
public void javacError(JavacErrorDetail[] details)
throws JasperException;
@@ -67,6 +70,7 @@ public interface ErrorHandler {
*
* @param errorReport Compilation error report
* @param exception Compilation exception
+ * @throws JasperException An error occurred
*/
public void javacError(String errorReport, Exception exception)
throws JasperException;
diff --git a/java/org/apache/jasper/compiler/JarResource.java b/java/org/apache/jasper/compiler/JarResource.java
index ea73855..614dfa7 100644
--- a/java/org/apache/jasper/compiler/JarResource.java
+++ b/java/org/apache/jasper/compiler/JarResource.java
@@ -26,7 +26,7 @@ public interface JarResource {
/**
* @return The JarFile for this resource. A new instance of JarFile
* should be returned on each call.
- * @throws IOException
+ * @throws IOException If an I/O error occurs reading the JAR
*/
JarFile getJarFile() throws IOException;
@@ -37,7 +37,7 @@ public interface JarResource {
String getUrl();
/**
- * @param name
+ * @param name Name of entry to return
* @return The URL for the entry within this resource.
*/
URL getEntry(String name);
diff --git a/java/org/apache/jasper/compiler/JarScannerFactory.java b/java/org/apache/jasper/compiler/JarScannerFactory.java
index 29a58a2..ea0350b 100644
--- a/java/org/apache/jasper/compiler/JarScannerFactory.java
+++ b/java/org/apache/jasper/compiler/JarScannerFactory.java
@@ -34,6 +34,8 @@ public class JarScannerFactory {
/**
* Obtain the {@link JarScanner} associated with the specified {@link
* ServletContext}. It is obtained via a context parameter.
+ * @param ctxt The Servlet context
+ * @return a scanner instance
*/
public static JarScanner getJarScanner(ServletContext ctxt) {
JarScanner jarScanner =
diff --git a/java/org/apache/jasper/compiler/JspConfig.java b/java/org/apache/jasper/compiler/JspConfig.java
index 8157138..506e0b1 100644
--- a/java/org/apache/jasper/compiler/JspConfig.java
+++ b/java/org/apache/jasper/compiler/JspConfig.java
@@ -296,6 +296,7 @@ public class JspConfig {
* Find a property that best matches the supplied resource.
* @param uri the resource supplied.
* @return a JspProperty indicating the best match, or some default.
+ * @throws JasperException Not used
*/
public JspProperty findJspProperty(String uri) throws JasperException {
@@ -459,6 +460,9 @@ public class JspConfig {
/**
* To find out if a uri matches a url pattern in jsp config. If so,
* then the uri is a JSP page. This is used primarily for jspc.
+ * @param uri The path to check
+ * @return <code>true</code> if the path denotes a JSP page
+ * @throws JasperException Not used
*/
public boolean isJspPage(String uri) throws JasperException {
diff --git a/java/org/apache/jasper/compiler/JspUtil.java b/java/org/apache/jasper/compiler/JspUtil.java
index 553b070..1fd1a38 100644
--- a/java/org/apache/jasper/compiler/JspUtil.java
+++ b/java/org/apache/jasper/compiler/JspUtil.java
@@ -243,6 +243,13 @@ public class JspUtil {
/**
* Replaces any occurrences of the character <code>replace</code> with the
* string <code>with</code>.
+ *
+ * @param name String in which character is to be replaced
+ * @param replace The character to replace
+ * @param with The string with which the character is to be replaced
+ *
+ * @return The supplied string with all instances of <code>replace</code>
+ * replaced with <code>with</code>
*/
public static String replace(String name, char replace, String with) {
StringBuilder buf = new StringBuilder();
diff --git a/java/org/apache/jasper/runtime/PageContextImpl.java b/java/org/apache/jasper/runtime/PageContextImpl.java
index 848f4b9..8d4cc07 100644
--- a/java/org/apache/jasper/runtime/PageContextImpl.java
+++ b/java/org/apache/jasper/runtime/PageContextImpl.java
@@ -932,6 +932,8 @@ public class PageContextImpl extends PageContext {
* The page context
* @param functionMap
* Maps prefix and name to Method
+ * @param escape
+ * Unused
* @return The result of the evaluation
* @throws ELException If an error occurs during the evaluation
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org