This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 9d0c1de Javadoc
9d0c1de is described below
commit 9d0c1de5495b3f8f2cc69a0f4224825dc0127087
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:21:43 2026 -0400
Javadoc
---
src/main/java/org/apache/bsf/BSFEngine.java | 30 +++++++++----------
src/main/java/org/apache/bsf/BSFManager.java | 34 +++++++++++-----------
.../org/apache/bsf/engines/jacl/JaclEngine.java | 2 +-
.../org/apache/bsf/engines/java/JavaEngine.java | 2 +-
.../bsf/engines/javascript/JavaScriptEngine.java | 2 +-
.../org/apache/bsf/engines/jexl/JEXLEngine.java | 12 ++++----
.../apache/bsf/engines/netrexx/NetRexxEngine.java | 4 +--
src/main/java/org/apache/bsf/util/EngineUtils.java | 6 ++--
.../java/org/apache/bsf/util/IndentWriter.java | 8 ++---
.../java/org/apache/bsf/util/ReflectionUtils.java | 12 ++++----
.../java/org/apache/bsf/util/cf/CodeFormatter.java | 8 ++---
11 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/src/main/java/org/apache/bsf/BSFEngine.java
b/src/main/java/org/apache/bsf/BSFEngine.java
index 84250bc..b459a46 100644
--- a/src/main/java/org/apache/bsf/BSFEngine.java
+++ b/src/main/java/org/apache/bsf/BSFEngine.java
@@ -44,8 +44,8 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
- * @param paramNames the names of the parameters above assumes
+ * @param funcBody The multi-line, value returning script to evaluate
+ * @param paramNames The names of the parameters above assumes
* @param arguments values of the above parameters
* @exception BSFException if anything goes wrong while doin' it.
*/
@@ -58,7 +58,7 @@ public interface BSFEngine extends PropertyChangeListener {
*
* @param object object on which to make the call
* @param name name of the method / procedure to call
- * @param args the arguments to be given to the procedure
+ * @param args The arguments to be given to the procedure
* @exception BSFException if anything goes wrong while eval'ing a
BSFException is thrown. The reason indicates the problem.
*/
Object call(Object object, String name, Object[] args) throws BSFException;
@@ -69,10 +69,10 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
- * @param paramNames the names of the parameters above assumes
+ * @param funcBody The multi-line, value returning script to evaluate
+ * @param paramNames The names of the parameters above assumes
* @param arguments values of the above parameters
- * @param cb the CodeBuffer to compile into
+ * @param cb The CodeBuffer to compile into
* @exception BSFException if anything goes wrong while doin' it.
*/
void compileApply(String source, int lineNo, int columnNo, Object
funcBody, Vector paramNames, Vector arguments, CodeBuffer cb) throws
BSFException;
@@ -84,8 +84,8 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
- * @param cb the CodeBuffer to compile into
+ * @param expr The expression to compile
+ * @param cb The CodeBuffer to compile into
* @exception BSFException if anything goes wrong while compiling a
BSFException is thrown. The reason indicates the problem.
*/
void compileExpr(String source, int lineNo, int columnNo, Object expr,
CodeBuffer cb) throws BSFException;
@@ -97,8 +97,8 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
- * @param cb the CodeBuffer to compile into
+ * @param script The script to compile
+ * @param cb The CodeBuffer to compile into
* @exception BSFException if anything goes wrong while compiling a
BSFException is thrown. The reason indicates the problem.
*/
void compileScript(String source, int lineNo, int columnNo, Object script,
CodeBuffer cb) throws BSFException;
@@ -107,7 +107,7 @@ public interface BSFEngine extends PropertyChangeListener {
* Declare a bean after the engine has been started. Declared beans are
beans that are named and which the engine must make available to the scripts it
runs
* in the most first class way possible.
*
- * @param bean the bean to declare
+ * @param bean The bean to declare
* @exception BSFException if the engine cannot do this operation
*/
void declareBean(BSFDeclaredBean bean) throws BSFException;
@@ -119,7 +119,7 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
+ * @param expr The expression to evaluate
* @exception BSFException if anything goes wrong while eval'ing a
BSFException is thrown. The reason indicates the problem.
*/
Object eval(String source, int lineNo, int columnNo, Object expr) throws
BSFException;
@@ -131,7 +131,7 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
+ * @param script The script to execute
* @exception BSFException if anything goes wrong while exec'ing a
BSFException is thrown. The reason indicates the problem.
*/
void exec(String source, int lineNo, int columnNo, Object script) throws
BSFException;
@@ -143,7 +143,7 @@ public interface BSFEngine extends PropertyChangeListener {
* @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
+ * @param script The script to execute
* @exception BSFException if anything goes wrong while exec'ing a
BSFException is thrown. The reason indicates the problem.
*/
void iexec(String source, int lineNo, int columnNo, Object script) throws
BSFException;
@@ -168,7 +168,7 @@ public interface BSFEngine extends PropertyChangeListener {
/**
* Undeclare a previously declared bean.
*
- * @param bean the bean to undeclare
+ * @param bean The bean to undeclare
* @exception BSFException if the engine cannot do this operation
*/
void undeclareBean(BSFDeclaredBean bean) throws BSFException;
diff --git a/src/main/java/org/apache/bsf/BSFManager.java
b/src/main/java/org/apache/bsf/BSFManager.java
index dd17373..59fa36b 100644
--- a/src/main/java/org/apache/bsf/BSFManager.java
+++ b/src/main/java/org/apache/bsf/BSFManager.java
@@ -234,8 +234,8 @@ public class BSFManager {
* @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
- * @param paramNames the names of the parameters above assumes
+ * @param funcBody The multi-line, value returning script to evaluate
+ * @param paramNames The names of the parameters above assumes
* @param arguments values of the above parameters
* @exception BSFException if anything goes wrong while running the script
*/
@@ -274,8 +274,8 @@ public class BSFManager {
* @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
- * @param paramNames the names of the parameters above assumes
+ * @param funcBody The multi-line, value returning script to evaluate
+ * @param paramNames The names of the parameters above assumes
* @param arguments values of the above parameters
* @param cb code buffer to compile into
* @exception BSFException if anything goes wrong while running the script
@@ -313,7 +313,7 @@ public class BSFManager {
* @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
+ * @param expr The expression to compile
* @param cb code buffer to compile into
* @exception BSFException if any error while compiling the expression
*/
@@ -348,7 +348,7 @@ public class BSFManager {
* @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
+ * @param script The script to compile
* @param cb code buffer to compile into
* @exception BSFException if any error while compiling the script
*/
@@ -390,8 +390,8 @@ public class BSFManager {
* rejects it. Also, its much more likely that an engine can declare a
bean at start time than it can at any time.
*
* @param beanName name to declare bean as
- * @param bean the bean that's being declared
- * @param type the type to represent the bean as
+ * @param bean The bean that's being declared
+ * @param type The type to represent the bean as
* @exception BSFException if any of the languages that are already
running decides to throw an exception when asked to declare this bean.
*/
public void declareBean(final String beanName, final Object bean, final
Class type) throws BSFException {
@@ -417,7 +417,7 @@ public class BSFManager {
* @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
+ * @param expr The expression to evaluate
* @exception BSFException if anything goes wrong while running the script
*/
public Object eval(final String lang, final String source, final int
lineNo, final int columnNo, final Object expr) throws BSFException {
@@ -459,7 +459,7 @@ public class BSFManager {
* @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
+ * @param script The script to execute
* @exception BSFException if anything goes wrong while running the script
*/
public void exec(final String lang, final String source, final int lineNo,
final int columnNo, final Object script) throws BSFException {
@@ -491,7 +491,7 @@ public class BSFManager {
* @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
+ * @param script The script to execute
* @exception BSFException if anything goes wrong while running the script
*/
public void iexec(final String lang, final String source, final int
lineNo, final int columnNo, final Object script) throws BSFException {
@@ -544,7 +544,7 @@ public class BSFManager {
/**
* Determine the language of a script file by looking at the file
extension.
*
- * @param fileName the name of the file
+ * @param fileName The name of the file
* @return The scripting language the file is in if the file extension is
known to me (must have been registered via registerScriptingEngine).
* @exception BSFException if file's extension is unknown.
*/
@@ -731,7 +731,7 @@ public class BSFManager {
* Registering a bean allows a scripting engine or the application to
access that bean by name and to manipulate it.
*
* @param beanName name to register under
- * @param bean the bean to register
+ * @param bean The bean to register
*/
public void registerBean(final String beanName, final Object bean) {
logger.debug("BSFManager:registerBean");
@@ -768,7 +768,7 @@ public class BSFManager {
/**
* Set the class loader for those that need to use it. Default is he who
loaded me or null (i.e., its Class.forName).
*
- * @param classLoader the class loader to use.
+ * @param classLoader The class loader to use.
*/
public void setClassLoader(final ClassLoader classLoader) {
logger.debug("BSFManager:setClassLoader");
@@ -780,7 +780,7 @@ public class BSFManager {
/**
* Set the classpath for those that need to use it. Default is the value
of the java.class.path property.
*
- * @param classPath the classpath to use
+ * @param classPath The classpath to use
*/
public void setClassPath(final String classPath) {
logger.debug("BSFManager:setClassPath");
@@ -792,7 +792,7 @@ public class BSFManager {
/**
* Set the object registry used by this manager. By default a new one is
created when the manager is new'ed and this overwrites that one.
*
- * @param objectRegistry the registry to use
+ * @param objectRegistry The registry to use
*/
public void setObjectRegistry(final ObjectRegistry objectRegistry) {
logger.debug("BSFManager:setObjectRegistry");
@@ -806,7 +806,7 @@ public class BSFManager {
* class loader property or, if that fails, a class loader which knows to
load from the tempdir to try to load the class. Default value of tempDir is "."
* (current working dir).
*
- * @param tempDir the temporary directory
+ * @param tempDir The temporary directory
*/
public void setTempDir(final String tempDir) {
logger.debug("BSFManager:setTempDir");
diff --git a/src/main/java/org/apache/bsf/engines/jacl/JaclEngine.java
b/src/main/java/org/apache/bsf/engines/jacl/JaclEngine.java
index b51c0b9..95011aa 100644
--- a/src/main/java/org/apache/bsf/engines/jacl/JaclEngine.java
+++ b/src/main/java/org/apache/bsf/engines/jacl/JaclEngine.java
@@ -44,7 +44,7 @@ public class JaclEngine extends BSFEngineImpl {
/**
*
* @param method The name of the method to call.
- * @param args an array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
+ * @param args An array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
*/
public Object call(final Object obj, final String method, final Object[]
args) throws BSFException {
final StringBuilder tclScript = new StringBuilder(method);
diff --git a/src/main/java/org/apache/bsf/engines/java/JavaEngine.java
b/src/main/java/org/apache/bsf/engines/java/JavaEngine.java
index d9082c7..b254444 100644
--- a/src/main/java/org/apache/bsf/engines/java/JavaEngine.java
+++ b/src/main/java/org/apache/bsf/engines/java/JavaEngine.java
@@ -264,7 +264,7 @@ public class JavaEngine extends BSFEngineImpl {
*
* @param object Object on which to make the internal_call (ignored).
* @param method The name of the method to internal_call.
- * @param args an array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
+ * @param args An array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
*/
Object internalCall(final Object object, final String method, final
Object[] args) throws BSFException {
// ***** ISSUE: Only static methods are currently supported
diff --git
a/src/main/java/org/apache/bsf/engines/javascript/JavaScriptEngine.java
b/src/main/java/org/apache/bsf/engines/javascript/JavaScriptEngine.java
index c2a9f15..cd6019f 100644
--- a/src/main/java/org/apache/bsf/engines/javascript/JavaScriptEngine.java
+++ b/src/main/java/org/apache/bsf/engines/javascript/JavaScriptEngine.java
@@ -52,7 +52,7 @@ public class JavaScriptEngine extends BSFEngineImpl {
*
* @param object Object on which to make the call (ignored).
* @param method The name of the method to call.
- * @param args an array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
+ * @param args An array of arguments to be passed to the extension,
which may be either Vectors of Nodes, or Strings.
*/
public Object call(final Object object, final String method, final
Object[] args) throws BSFException {
diff --git a/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
b/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
index 6eb2148..89c0e9f 100644
--- a/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
+++ b/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
@@ -65,7 +65,7 @@ public class JEXLEngine extends BSFEngineImpl {
/**
* Sets the JEXL engine permissions.
*
- * @param permissions the permissions
+ * @param permissions The permissions
*/
public static void setPermissions(JexlPermissions permissions) {
BSF_PERMISSIONS = permissions;
@@ -73,7 +73,7 @@ public class JEXLEngine extends BSFEngineImpl {
/**
* Sets the JEXL engine features.
- * @param features the features
+ * @param features The features
*/
public static void setFeatures(JexlFeatures features) {
BSF_FEATURES = features;
@@ -245,8 +245,8 @@ public class JEXLEngine extends BSFEngineImpl {
/**
* Reads a JEXL source from a File.
*
- * @param info the script source info
- * @param file the script file
+ * @param info The script source info
+ * @param file The script file
* @return The source
*/
protected String readSource(JexlInfo info, final File file) {
@@ -261,8 +261,8 @@ public class JEXLEngine extends BSFEngineImpl {
/**
* Reads a JEXL source from an URL.
*
- * @param info the script source info
- * @param url the script url
+ * @param info The script source info
+ * @param url The script url
* @return The source
*/
protected String readSource(JexlInfo info, final URL url) {
diff --git a/src/main/java/org/apache/bsf/engines/netrexx/NetRexxEngine.java
b/src/main/java/org/apache/bsf/engines/netrexx/NetRexxEngine.java
index d28279d..e088645 100644
--- a/src/main/java/org/apache/bsf/engines/netrexx/NetRexxEngine.java
+++ b/src/main/java/org/apache/bsf/engines/netrexx/NetRexxEngine.java
@@ -144,7 +144,7 @@ public class NetRexxEngine extends BSFEngineImpl
*
* @param object object from which to call our static method
* @param method The name of the method to call.
- * @param args an array of arguments to be
+ * @param args An array of arguments to be
* passed to the extension, which may be either
* Vectors of Nodes, or Strings.
*/
@@ -161,7 +161,7 @@ public class NetRexxEngine extends BSFEngineImpl
*
* @param rexxclass Class to invoke the method against
* @param method The name of the method to call.
- * @param args an array of arguments to be
+ * @param args An array of arguments to be
* passed to the extension, which may be either
* Vectors of Nodes, or Strings.
*/
diff --git a/src/main/java/org/apache/bsf/util/EngineUtils.java
b/src/main/java/org/apache/bsf/util/EngineUtils.java
index 632e729..1c4aa84 100644
--- a/src/main/java/org/apache/bsf/util/EngineUtils.java
+++ b/src/main/java/org/apache/bsf/util/EngineUtils.java
@@ -71,7 +71,7 @@ public class EngineUtils {
* @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 script The script to execute when the event occurs
* @exception BSFException if anything goes wrong while running the script
*/
public static void addEventListener(final Object bean, final String
eventSetName, final String filter, final BSFEngine engine, final BSFManager
manager,
@@ -98,7 +98,7 @@ public class EngineUtils {
* @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 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 for example
for indicating to the scripting engine which scripting engine
* object/routine/function/procedure should
be ultimately informed of the event occurrence.
@@ -125,7 +125,7 @@ public class EngineUtils {
* args, but if that fails, this tries to convert any primitive wrapper
type args to their primitive counterparts to see whether a method exists that
way.
* If it does, done.
*
- * @param bean the object on which to invoke the method
+ * @param bean The object on which to invoke the method
* @param methodName name of the method
* @param args arguments to be given to the method
* @return The result of invoking the method, if any
diff --git a/src/main/java/org/apache/bsf/util/IndentWriter.java
b/src/main/java/org/apache/bsf/util/IndentWriter.java
index c24fd1e..e952a05 100644
--- a/src/main/java/org/apache/bsf/util/IndentWriter.java
+++ b/src/main/java/org/apache/bsf/util/IndentWriter.java
@@ -58,8 +58,8 @@ public class IndentWriter extends PrintWriter {
/**
* Print the text (indented the specified amount) without inserting a
linefeed.
*
- * @param numberOfSpaces the number of spaces to indent the text.
- * @param text the text to print.
+ * @param numberOfSpaces The number of spaces to indent the text.
+ * @param text The text to print.
*/
public void print(final int numberOfSpaces, final String text) {
super.print(StringUtils.getChars(numberOfSpaces, ' ') + text);
@@ -68,8 +68,8 @@ public class IndentWriter extends PrintWriter {
/**
* Print the text (indented the specified amount) and insert a linefeed.
*
- * @param numberOfSpaces the number of spaces to indent the text.
- * @param text the text to print.
+ * @param numberOfSpaces The number of spaces to indent the text.
+ * @param text The text to print.
*/
public void println(final int numberOfSpaces, final String text) {
super.println(StringUtils.getChars(numberOfSpaces, ' ') + text);
diff --git a/src/main/java/org/apache/bsf/util/ReflectionUtils.java
b/src/main/java/org/apache/bsf/util/ReflectionUtils.java
index d908323..7438a90 100644
--- a/src/main/java/org/apache/bsf/util/ReflectionUtils.java
+++ b/src/main/java/org/apache/bsf/util/ReflectionUtils.java
@@ -189,7 +189,7 @@ public class ReflectionUtils {
/**
* Create a bean using given class loader and using the appropriate
constructor for the given args of the given arg types.
*
- * @param cld the class loader to use. If null, Class.forName is
used.
+ * @param cld The class loader to use. If null, Class.forName is
used.
* @param className name of class to instantiate
* @param argTypes array of argument types
* @param args array of arguments
@@ -255,7 +255,7 @@ public class ReflectionUtils {
/**
* Create a bean using given class loader and using the appropriate
constructor for the given args. Figures out the arg types and calls above.
*
- * @param cld the class loader to use. If null, Class.forName is
used.
+ * @param cld The class loader to use. If null, Class.forName is
used.
* @param className name of class to instantiate
* @param args array of arguments
* @return The newly created bean
@@ -312,7 +312,7 @@ public class ReflectionUtils {
/**
* Get a property of a bean.
*
- * @param target the object whose prop is to be gotten
+ * @param target The object whose prop is to be gotten
* @param propName name of the property to set
* @param index index to get (if property is indexed)
* @exception IntrospectionException if unable to introspect
@@ -399,11 +399,11 @@ public class ReflectionUtils {
/**
* Set a property of a bean to a given value.
*
- * @param target the object whose prop is to be set
+ * @param target The object whose prop is to be set
* @param propName name of the property to set
* @param index index to set (if property is indexed)
- * @param value the property value
- * @param valueType the type of the above (needed when its null)
+ * @param value The property value
+ * @param valueType The type of the above (needed when its null)
* @param tcr type convertor registry to use to convert value type
to property type if necessary
* @exception IntrospectionException if unable to introspect
* @exception IllegalArgumentException if problems with args: if the
property is unknown, or if the property is given an index when its not, or if
the
diff --git a/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
b/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
index 7933d24..8f6cb92 100644
--- a/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
+++ b/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
@@ -288,7 +288,7 @@ public class CodeFormatter {
* character on the following line</em>. A quotation mark, {@code "} or
{@code '}, opening a string is always a delimiter, whether you specify it
* or not.
*
- * @param newDelimiters the new set of delimiters.
+ * @param newDelimiters The new set of delimiters.
* @see #getDelimiters
*/
public void setDelimiters(final String newDelimiters) {
@@ -300,7 +300,7 @@ public class CodeFormatter {
* <p>
* This is the number of spaces that lines will be indented (when
appropriate).
*
- * @param newIndentationStep the new size of the indentation step.
+ * @param newIndentationStep The new size of the indentation step.
* @see #getIndentationStep
*/
public void setIndentationStep(final int newIndentationStep) {
@@ -312,7 +312,7 @@ public class CodeFormatter {
* <p>
* If a token is longer than the requested maximum line length, then the
line containing that token will obviously be longer than the desired maximum.
*
- * @param newMaxLineLength the new maximum line length.
+ * @param newMaxLineLength The new maximum line length.
* @see #getMaxLineLength
*/
public void setMaxLineLength(final int newMaxLineLength) {
@@ -326,7 +326,7 @@ public class CodeFormatter {
* appear as the <em>last character on the current line</em>. A quotation
mark, {@code "} or {@code '}, closing a string is always a sticky
* delimiter, whether you specify it or not.
*
- * @param newStickyDelimiters the new set of sticky delimiters.
+ * @param newStickyDelimiters The new set of sticky delimiters.
* @see #getStickyDelimiters
*/
public void setStickyDelimiters(final String newStickyDelimiters) {