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-jelly.git
The following commit(s) were added to refs/heads/master by this push:
new 568e0ad4 Javadoc
568e0ad4 is described below
commit 568e0ad43bffdf912aec6636d9010d4c81284f0a
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Dec 30 13:47:54 2025 +0000
Javadoc
---
.../org/apache/commons/jelly/tags/ant/AntTag.java | 15 +++---
.../commons/jelly/tags/ant/GrantProject.java | 10 ++--
.../commons/jelly/tags/ant/JellyPropsHandler.java | 10 ++--
.../commons/jelly/tags/ant/PropsHandler.java | 54 +++++++++++-----------
.../commons/jelly/tags/quartz/CronTriggerTag.java | 24 +++++-----
.../apache/commons/jelly/tags/quartz/JellyJob.java | 4 +-
.../apache/commons/jelly/tags/quartz/JobTag.java | 14 +++---
.../jelly/tags/quartz/QuartzTagSupport.java | 4 +-
.../jelly/tags/quartz/WaitForSchedulerTag.java | 4 +-
.../tags/swing/impl/GridBagConstraintBean.java | 8 ++--
10 files changed, 76 insertions(+), 71 deletions(-)
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
index aef443fa..dcd73942 100644
--- a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
+++ b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
@@ -68,9 +68,10 @@ public class AntTag extends MapTagSupport implements
TaskSource {
/** Task, if this tag represents a task. */
protected Task task;
- /** Constructs with a project and tag name.
+ /**
+ * Constructs with a project and tag name.
*
- * @param tagName The name on the tag.
+ * @param tagName The name on the tag.
*/
public AntTag(final String tagName) {
this.tagName = tagName;
@@ -440,9 +441,10 @@ public class AntTag extends MapTagSupport implements
TaskSource {
return this.tagName;
}
- /** Retrieve the general object underlying this tag.
+ /*
+ * Retrieve the general object underlying this tag.
*
- * @return The object underlying this tag.
+ * @return The object underlying this tag.
*/
@Override
public Object getTaskObject() {
@@ -527,9 +529,10 @@ public class AntTag extends MapTagSupport implements
TaskSource {
}
}
- /** Sets the object underlying this tag.
+ /**
+ * Sets the object underlying this tag.
*
- * @param object The object.
+ * @param object The object.
*/
public void setObject(final Object object) {
this.object = object;
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/GrantProject.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/GrantProject.java
index a84edccf..834d3fe3 100644
---
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/GrantProject.java
+++
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/GrantProject.java
@@ -103,9 +103,10 @@ public class GrantProject extends Project {
return this.propsHandler.getProperty(key);
}
- /** Retrieve the currently installed {@code PropsHandler}.
+ /**
+ * Retrieve the currently installed {@code PropsHandler}.
*
- * @return The currently installed {@code PropsHandler},
+ * @return The currently installed {@code PropsHandler},
* or {@code null} if no {@code PropsHandler}
* had yet to be installed.
*/
@@ -187,9 +188,10 @@ public class GrantProject extends Project {
}
}
- /** Install a {@code PropsHandler} delegate.
+ /**
+ * Install a {@code PropsHandler} delegate.
*
- * @param propsHandler The {@code PropsHandler} to install,
+ * @param propsHandler The {@code PropsHandler} to install,
* or {@code null} to remove any currently installed
* {@code PropsHandler}.
*/
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/JellyPropsHandler.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/JellyPropsHandler.java
index c2f50ce9..d97e3357 100644
---
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/JellyPropsHandler.java
+++
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/JellyPropsHandler.java
@@ -41,7 +41,7 @@ public class JellyPropsHandler extends DefaultPropsHandler {
/** Retrieve all ant properties.
*
- * @return A {@code Hashtable} of all properties.
+ * @return A {@code Hashtable} of all properties.
*/
@Override
public Hashtable getProperties() {
@@ -58,9 +58,9 @@ public class JellyPropsHandler extends DefaultPropsHandler {
/** Retrieve an ant property.
*
- * @param name The property name.
+ * @param name The property name.
*
- * @return The property value.
+ * @return The property value.
*/
@Override
public String getProperty(final String name) {
@@ -79,8 +79,8 @@ public class JellyPropsHandler extends DefaultPropsHandler {
/** Sets an ant property.
*
- * @param name The property name.
- * @param value The property value.
+ * @param name The property name.
+ * @param value The property value.
*/
@Override
public void setProperty(final String name, final String value) {
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/PropsHandler.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/PropsHandler.java
index ba2ad755..3fdddca7 100644
---
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/PropsHandler.java
+++
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/PropsHandler.java
@@ -22,20 +22,20 @@ import java.util.Hashtable;
import org.apache.tools.ant.Project;
/** Interface for delegates supporting property management
- * for a{@code GrantProject}.
+ * for a{@code GrantProject}.
*
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setNewProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setUserProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setInheritedProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#getProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#getUserProperty
- * @see org.apache.commons.jelly.tags.ant.GrantProject#getProperties
- * @see org.apache.commons.jelly.tags.ant.GrantProject#getUserProperties
- * @see org.apache.commons.jelly.tags.ant.GrantProject#copyUserProperties
- * @see org.apache.commons.jelly.tags.ant.GrantProject#copyInheritedProperties
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setSystemProperties
- * @see org.apache.commons.jelly.tags.ant.GrantProject#setJavaVersionProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setNewProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setUserProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setInheritedProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#getProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#getUserProperty
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#getProperties
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#getUserProperties
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#copyUserProperties
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#copyInheritedProperties
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setSystemProperties
+ * @see org.apache.commons.jelly.tags.ant.GrantProject#setJavaVersionProperty
*/
public interface PropsHandler {
@@ -53,36 +53,36 @@ public interface PropsHandler {
/** Retrieve a {@code Hashtable} of all properties.
*
- * @return A {@code Hashtable} of all properties.
+ * @return A {@code Hashtable} of all properties.
*/
Hashtable getProperties();
/** Retrieve a property.
*
- * @param key The property key.
+ * @param key The property key.
*
- * @return The value.
+ * @return The value.
*/
String getProperty(String key);
/** Retrieve a {@code Hashtable} of all user properties.
*
- * @return A {@code Hashtable} of all user properties.
+ * @return A {@code Hashtable} of all user properties.
*/
Hashtable getUserProperties();
/** Retrieve a user property.
*
- * @param key The user property key.
+ * @param key The user property key.
*
- * @return The value.
+ * @return The value.
*/
String getUserProperty(String key);
/** Sets an inherited property.
*
- * @param key The user property key.
- * @param value The value.
+ * @param key The user property key.
+ * @param value The value.
*/
void setInheritedProperty(String key, String value);
@@ -92,15 +92,15 @@ public interface PropsHandler {
/** Sets a new property.
*
- * @param key The property key.
- * @param value The value.
+ * @param key The property key.
+ * @param value The value.
*/
void setNewProperty(String key, String value);
/** Sets a property.
*
- * @param key The property key.
- * @param value The value.
+ * @param key The property key.
+ * @param value The value.
*/
void setProperty(String key, String value);
@@ -121,8 +121,8 @@ public interface PropsHandler {
/** Sets a user property.
*
- * @param key The user property key.
- * @param value The value.
+ * @param key The user property key.
+ * @param value The value.
*/
void setUserProperty(String key, String value);
diff --git
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/CronTriggerTag.java
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/CronTriggerTag.java
index 0258310c..31c04fff 100644
---
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/CronTriggerTag.java
+++
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/CronTriggerTag.java
@@ -55,10 +55,10 @@ public class CronTriggerTag extends QuartzTagSupport
/** Perform this tag.
*
- * @param output Output sink.
+ * @param output Output sink.
*
- * @throws MissingAttributeException If an error occurs.
- * @throws JellyTagException If an error occurs.
+ * @throws MissingAttributeException If an error occurs.
+ * @throws JellyTagException If an error occurs.
*/
@Override
public void doTag(final XMLOutput output) throws
MissingAttributeException, JellyTagException
@@ -111,7 +111,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Retrieve the group.
*
- * @return The group.
+ * @return The group.
*/
public String getGroup()
{
@@ -120,7 +120,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Retrieve the job group.
*
- * @return The job group.
+ * @return The job group.
*/
public String getJobGroup()
{
@@ -129,7 +129,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Retrieve the job name.
*
- * @return The job name.
+ * @return The job name.
*/
public String getJobName()
{
@@ -138,7 +138,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Retrieve the name.
*
- * @return The name.
+ * @return The name.
*/
public String getName()
{
@@ -154,7 +154,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Sets the group
*
- * @param group The group
+ * @param group The group
*/
public void setGroup(final String group)
{
@@ -163,7 +163,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Sets the job group.
*
- * @param jobGroup The job group.
+ * @param jobGroup The job group.
*/
public void setJobGroup(final String jobGroup)
{
@@ -172,7 +172,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Sets the job name.
*
- * @param jobName The job name.
+ * @param jobName The job name.
*/
public void setJobName(final String jobName)
{
@@ -181,7 +181,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Sets the name.
*
- * @param name.
+ * @param name.
*/
public void setName(final String name)
{
@@ -194,7 +194,7 @@ public class CronTriggerTag extends QuartzTagSupport
/** Sets the cron time spec.
*
- * @param spec The cron time spec.
+ * @param spec The cron time spec.
*/
public void setSpec(final String spec)
{
diff --git
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JellyJob.java
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JellyJob.java
index 75b77e0a..aaa5730d 100644
---
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JellyJob.java
+++
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JellyJob.java
@@ -43,9 +43,9 @@ public class JellyJob implements Job
/** Execute this job.
*
- * @param jobContext Job context data.
+ * @param jobContext Job context data.
*
- * @throws JobExecutionException If an error occurs during job execution.
+ * @throws JobExecutionException If an error occurs during job execution.
*/
@Override
public void execute(final JobExecutionContext jobContext) throws
JobExecutionException
diff --git
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JobTag.java
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JobTag.java
index 5aba33aa..76ec6b75 100644
---
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JobTag.java
+++
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/JobTag.java
@@ -44,10 +44,10 @@ public class JobTag extends QuartzTagSupport
/** Perform this tag.
*
- * @param output Output sink.
+ * @param output Output sink.
*
- * @throws MissingAttributeException If an error occurs.
- * @throws JellyTagException If an error occurs.
+ * @throws MissingAttributeException If an error occurs.
+ * @throws JellyTagException If an error occurs.
*/
@Override
public void doTag(final XMLOutput output) throws
MissingAttributeException, JellyTagException
@@ -93,7 +93,7 @@ public class JobTag extends QuartzTagSupport
/** Retrieve the group of this job.
*
- * @return The group of this job.
+ * @return The group of this job.
*/
public String getGroup()
{
@@ -102,7 +102,7 @@ public class JobTag extends QuartzTagSupport
/** Retrieve the name of this job.
*
- * @return The name of this job.
+ * @return The name of this job.
*/
public String getName()
{
@@ -111,7 +111,7 @@ public class JobTag extends QuartzTagSupport
/** Sets the group of this job.
*
- * @param group The group of this job.
+ * @param group The group of this job.
*/
public void setGroup(final String group)
{
@@ -124,7 +124,7 @@ public class JobTag extends QuartzTagSupport
/** Sets the name of this job.
*
- * @param name The name of this job.
+ * @param name The name of this job.
*/
public void setName(final String name)
{
diff --git
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/QuartzTagSupport.java
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/QuartzTagSupport.java
index 7f384a27..0b462fc7 100644
---
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/QuartzTagSupport.java
+++
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/QuartzTagSupport.java
@@ -38,9 +38,9 @@ public abstract class QuartzTagSupport extends TagSupport
* created, started, and installed. Additionally, a runtime
* shutdown hook will be added to cleanly shutdown the scheduler.
*
- * @return The scheduler.
+ * @return The scheduler.
*
- * @throws SchedulerException If there is an error creating the
+ * @throws SchedulerException If there is an error creating the
* scheduler.
*/
public Scheduler getScheduler() throws SchedulerException
diff --git
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/WaitForSchedulerTag.java
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/WaitForSchedulerTag.java
index bc75f0ec..cf2ba52a 100644
---
a/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/WaitForSchedulerTag.java
+++
b/jelly-tags/quartz/src/main/java/org/apache/commons/jelly/tags/quartz/WaitForSchedulerTag.java
@@ -40,9 +40,9 @@ public class WaitForSchedulerTag extends QuartzTagSupport
/** Perform this tag.
*
- * @param output Output sink.
+ * @param output Output sink.
*
- * @throws JellyTagException If an error occurs.
+ * @throws JellyTagException If an error occurs.
*/
@Override
public void doTag(final XMLOutput output) throws JellyTagException
diff --git
a/jelly-tags/swing/src/main/java/org/apache/commons/jelly/tags/swing/impl/GridBagConstraintBean.java
b/jelly-tags/swing/src/main/java/org/apache/commons/jelly/tags/swing/impl/GridBagConstraintBean.java
index d521d452..feab7a1d 100644
---
a/jelly-tags/swing/src/main/java/org/apache/commons/jelly/tags/swing/impl/GridBagConstraintBean.java
+++
b/jelly-tags/swing/src/main/java/org/apache/commons/jelly/tags/swing/impl/GridBagConstraintBean.java
@@ -53,7 +53,7 @@ public class GridBagConstraintBean extends GridBagConstraints
{
/** Returns the lower-case variant of the constant-name
* corresponding to the stored {@link #anchor} attribute.
*
- * @see #anchor
+ * @see #anchor
*/
public String getAnchor() {
switch (this.anchor) {
@@ -117,7 +117,7 @@ public class GridBagConstraintBean extends
GridBagConstraints {
/** Returns the lower-case variant of the constant-name
* corresponding to the stored {@link #fill} attribute.
*
- * @see #fill
+ * @see #fill
*/
public String getFill() {
switch (fill) {
@@ -170,7 +170,7 @@ public class GridBagConstraintBean extends
GridBagConstraints {
* and sets the {@link #anchor} value accordingly.
* The accepted strings are case-insensitive.
*
- * @see #anchor
+ * @see #anchor
*/
public void setAnchor(final String anchorString) {
final String lcAnchorString = anchorString.toLowerCase();
@@ -284,7 +284,7 @@ public class GridBagConstraintBean extends
GridBagConstraints {
* and sets the {@link #fill} value accordingly.
* The accepted strings are case-insensitive.
*
- * @see #fill
+ * @see #fill
*/
public void setFill(final String fillString) {
final String lcFillString = fillString.toLowerCase();
