This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bsf.git
The following commit(s) were added to refs/heads/master by this push:
new e6824b5 Javadoc: English, not Latin
e6824b5 is described below
commit e6824b52cda1267a5b6ba108bca317d34e448e3f
Author: Gary D. Gregory <[email protected]>
AuthorDate: Tue Dec 31 08:32:38 2024 -0500
Javadoc: English, not Latin
---
src/main/java/org/apache/bsf/BSFEngine.java | 14 +++++++-------
src/main/java/org/apache/bsf/BSFManager.java | 14 +++++++-------
src/main/java/org/apache/bsf/BSF_Log.java | 2 +-
.../bsf/util/BSFEventProcessorReturningEventInfos.java | 6 +++---
src/main/java/org/apache/bsf/util/EngineUtils.java | 6 +++---
5 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/src/main/java/org/apache/bsf/BSFEngine.java
b/src/main/java/org/apache/bsf/BSFEngine.java
index bf31fff..dc1bc71 100644
--- a/src/main/java/org/apache/bsf/BSFEngine.java
+++ b/src/main/java/org/apache/bsf/BSFEngine.java
@@ -41,7 +41,7 @@ public interface BSFEngine extends PropertyChangeListener {
* These are separated from expressions and scripts because the prior are
spsed to be good 'ol expressions and scripts are not value returning. We allow
* anonymous functions to have parameters as well for completeness.
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param funcBody the multi-line, value returning script to evaluate
@@ -66,7 +66,7 @@ public interface BSFEngine extends PropertyChangeListener {
/**
* This is used by an application to compile an anonymous function. See
comments in apply for more hdetails.
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param funcBody the multi-line, value returning script to evaluate
@@ -81,7 +81,7 @@ public interface BSFEngine extends PropertyChangeListener {
* This is used by an application to compile a value-returning expression.
The expr may be string or some other type, depending on the language. The
* generated code is dumped into the {@code CodeBuffer}.
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param expr the expression to compile
@@ -94,7 +94,7 @@ public interface BSFEngine extends PropertyChangeListener {
* This is used by an application to compile some script. The script may
be string or some other type, depending on the language. The generated code is
* dumped into the {@code CodeBuffer}.
*
- * @param source (context info) the source of this script (e.g.,
filename)
+ * @param source (context info) the source of this script (for example,
filename)
* @param lineNo (context info) the line number in source for script
* @param columnNo (context info) the column number in source for script
* @param script the script to compile
@@ -116,7 +116,7 @@ public interface BSFEngine extends PropertyChangeListener {
* This is used by an application to evaluate an expression. The
expression may be string or some other type, depending on the language. (For
example, for
* BML it'll be an org.w3c.dom.Element object.)
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param expr the expression to evaluate
@@ -128,7 +128,7 @@ public interface BSFEngine extends PropertyChangeListener {
* This is used by an application to execute some script. The expression
may be string or some other type, depending on the language. Returns nothing
but if
* something goes wrong it excepts (of course).
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param script the script to execute
@@ -140,7 +140,7 @@ public interface BSFEngine extends PropertyChangeListener {
* This is used by an application to execute some script, as though one
were interacting with the language in an interactive session. The expression
may be
* string or some other type, depending on the language. Returns nothing
but if something goes wrong it excepts (of course).
*
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param script the script to execute
diff --git a/src/main/java/org/apache/bsf/BSFManager.java
b/src/main/java/org/apache/bsf/BSFManager.java
index a649e0a..eba0e8f 100644
--- a/src/main/java/org/apache/bsf/BSFManager.java
+++ b/src/main/java/org/apache/bsf/BSFManager.java
@@ -231,7 +231,7 @@ public class BSFManager {
* Apply the given anonymous function of the given language to the given
parameters and return the resulting value.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param funcBody the multi-line, value returning script to evaluate
@@ -271,7 +271,7 @@ public class BSFManager {
* Compile the application of the given anonymous function of the given
language to the given parameters into the given {@code CodeBuffer}.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param funcBody the multi-line, value returning script to evaluate
@@ -310,7 +310,7 @@ public class BSFManager {
* Compile the given expression of the given language into the given
{@code CodeBuffer}.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param expr the expression to compile
@@ -345,7 +345,7 @@ public class BSFManager {
* Compile the given script of the given language into the given {@code
CodeBuffer}.
*
* @param lang language identifier
- * @param source (context info) the source of this script (e.g.,
filename)
+ * @param source (context info) the source of this script (for example,
filename)
* @param lineNo (context info) the line number in source for script
* @param columnNo (context info) the column number in source for script
* @param script the script to compile
@@ -414,7 +414,7 @@ public class BSFManager {
* Evaluate the given expression of the given language and return the
resulting value.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param expr the expression to evaluate
@@ -456,7 +456,7 @@ public class BSFManager {
* Execute the given script of the given language.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param script the script to execute
@@ -488,7 +488,7 @@ public class BSFManager {
* Execute the given script of the given language, attempting to emulate
an interactive session w/ the language.
*
* @param lang language identifier
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param script the script to execute
diff --git a/src/main/java/org/apache/bsf/BSF_Log.java
b/src/main/java/org/apache/bsf/BSF_Log.java
index d2baefa..b6e0cfa 100644
--- a/src/main/java/org/apache/bsf/BSF_Log.java
+++ b/src/main/java/org/apache/bsf/BSF_Log.java
@@ -34,7 +34,7 @@ import java.lang.reflect.*;
/*
* ---rgf, 2007-01-29, loading and invoking all methods via reflection ---rgf,
2007-09-17, adjusted for using default class loader, if system class loader
fails
* ---rgf, 2011-01-08, cf. [https://issues.apache.org/jira/browse/BSF-37] -
context class loader may not be set, account for it (2009-09-10) - fix logic
error
- * if context class loader is not set (e.g. observed on MacOSX, 2011-01-08)
+ * if context class loader is not set (for example observed on MacOSX,
2011-01-08)
*/
//@Immutable
diff --git
a/src/main/java/org/apache/bsf/util/BSFEventProcessorReturningEventInfos.java
b/src/main/java/org/apache/bsf/util/BSFEventProcessorReturningEventInfos.java
index 551dbbe..d316774 100644
---
a/src/main/java/org/apache/bsf/util/BSFEventProcessorReturningEventInfos.java
+++
b/src/main/java/org/apache/bsf/util/BSFEventProcessorReturningEventInfos.java
@@ -58,13 +58,13 @@ public class BSFEventProcessorReturningEventInfos
implements EventProcessor {
Object dataFromScriptingEngine; // ---rgf, 2006-02-24: data coming from the
// script engine, could be
- // e.g. an object reference to forward event with received arguments to
+ // for example an object reference to forward event with received
arguments to
/**
* Package-protected constructor makes this class unavailable for public
use.
*
* @param dataFromScriptingEngine this contains any object supplied by the
scripting engine and gets sent back with the supplied script. This could be used
- * e.g. for indicating which scripting
engine object should be ultimately informed of the event occurrence.
+ * for example for indicating which
scripting engine object should be ultimately informed of the event occurrence.
*/
BSFEventProcessorReturningEventInfos(final BSFEngine engine, final
BSFManager manager, final String filter, final String source, final int lineNo,
final int columnNo, final Object script, final Object
dataFromScriptingEngine) throws BSFException {
@@ -145,7 +145,7 @@ public class BSFEventProcessorReturningEventInfos
implements EventProcessor {
paramValues.add(this.filter); // can be null as well
// parameter # 5
- // BSF manager instance (e.g. allows access to its registry)
+ // BSF manager instance (for example allows access to its registry)
paramNames.add("BSFManager");
paramValues.add(this.manager);
diff --git a/src/main/java/org/apache/bsf/util/EngineUtils.java
b/src/main/java/org/apache/bsf/util/EngineUtils.java
index 1a84711..c0bdf38 100644
--- a/src/main/java/org/apache/bsf/util/EngineUtils.java
+++ b/src/main/java/org/apache/bsf/util/EngineUtils.java
@@ -68,7 +68,7 @@ public class EngineUtils {
* @param filter filter for events
* @param engine BSFEngine which can run this script
* @param manager BSFManager of the above engine
- * @param source (context info) the source of this expression (e.g.,
filename)
+ * @param source (context info) the source of this expression (for
example, filename)
* @param lineNo (context info) the line number in source for expr
* @param columnNo (context info) the column number in source for expr
* @param script the script to execute when the event occurs
@@ -95,12 +95,12 @@ public class EngineUtils {
* @param filter filter for events
* @param engine BSFEngine which can run this script
* @param manager BSFManager of the above engine
- * @param source (context info) the source of this
expression (e.g., filename)
+ * @param source (context info) the source of this
expression (for example, filename)
* @param lineNo (context info) the line number in source
for expr
* @param columnNo (context info) the column number in
source for expr
* @param script the script to execute when the event
occurs
* @param dataFromScriptingEngine this contains any object supplied by the
scripting engine and gets sent back with the supplied script, if the event
- * occurs. This could be used e.g. for
indicating to the scripting engine which scripting engine
+ * occurs. This could be used for example
for indicating to the scripting engine which scripting engine
* object/routine/function/procedure should
be ultimately informed of the event occurrence.
*
* @exception BSFException if anything goes wrong while running the script
