Author: gvanmatre
Date: Mon Aug 29 21:37:46 2005
New Revision: 264702
URL: http://svn.apache.org/viewcvs?rev=264702&view=rev
Log:
Fixed some javadoc errors.
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/faces/ClayViewHandler.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/Parser.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/Builder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/CommentBuilder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/MorphBuilder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectManyMenuBuilder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneMenuBuilder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneRadioBuilder.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/BuilderRuleContext.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/DefaultBuilderRule.java
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/SelectBuilderRule.java
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/faces/ClayViewHandler.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/faces/ClayViewHandler.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/faces/ClayViewHandler.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/faces/ClayViewHandler.java
Mon Aug 29 21:37:46 2005
@@ -82,9 +82,9 @@
private String suffix = null;
/**
- * <p>Cached [EMAIL PROTECTED] ViewControllerMapper} we will use to
translate
+ * <p>The cached [EMAIL PROTECTED] ViewControllerMapper} we will use to
translate
* view identifiers to the class name of a [EMAIL PROTECTED]
ViewController}.
- * This code is borrowed from [EMAIL PROTECTED] ShaleViewController}.</p>
+ * This code is borrowed from <code>ShaleViewController</code>.</p>
*/
private ViewControllerMapper mapper = null;
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/Parser.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/Parser.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/Parser.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/Parser.java
Mon Aug 29 21:37:46 2005
@@ -236,8 +236,7 @@
* type is a list because the fragment might not be well-formed.
* </p>
*
- * @param document
- * input source
+ * @param document input source
* @return collection of [EMAIL PROTECTED] Node}
*/
public List parse(StringBuffer document) {
@@ -567,7 +566,7 @@
/**
* <p>Explicitly sets the <code>isEnd</code> [EMAIL PROTECTED] Node}
property to <code>true</code> for
- * self terminating tags. Sets the [EMAIL PROTECTED]'s
<code>isWellFormed</code> property
+ * self terminating tags. Sets the [EMAIL PROTECTED] Node}'s
<code>isWellFormed</code> property
* to <code>true</code> if the <code>isStart</code> and <code>isEnd</code>
* [EMAIL PROTECTED] Node} properties are <code>true</code>.</p>
*/
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/Builder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/Builder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/Builder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/Builder.java
Mon Aug 29 21:37:46 2005
@@ -39,7 +39,7 @@
* HTML document into a tree structure of
* [EMAIL PROTECTED] org.apache.shale.clay.parser.Node}. Each node in the
parsed document
* tree is mapped to a <code>Builder</code> by a a subclass of
- * [EMAIL PROTECTED]
org.apache.shale.clay.parse.builder.chain.BuilderRuleContext}.
+ * [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.chain.BuilderRuleContext}.
* </p>
*/
public abstract class Builder {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/CommentBuilder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/CommentBuilder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/CommentBuilder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/CommentBuilder.java
Mon Aug 29 21:37:46 2005
@@ -34,8 +34,8 @@
public class CommentBuilder extends VerbatimBuilder {
/**
- * <p>This method is overridden to return a true value indicating
- * that this [EMAIL PROTECTED] Builder{ will handle child nodes under the
+ * <p>This method is overridden to return a <code>true</code> value
indicating
+ * that this [EMAIL PROTECTED] Builder} will handle child nodes under the
* associated HTML [EMAIL PROTECTED] Node}. This method can easily be
confused
* with the <code>isChildrenAllowed()</code> method of the super
* class [EMAIL PROTECTED] Builder}. The distinction is that the
@@ -49,9 +49,10 @@
}
/**
- * <p>The super implementation is invoked to build a target [EMAIL
PROTECTED] ElementBean}.
- * The body of the comment is constructed by capturing the text of all
child
- * HTML nodes within the comment body.</p>
+ * <p>The super implementation is invoked to build a target
+ * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}.
+ * The body of the comment is constructed by capturing the text
+ * of all child HTML nodes within the comment body.</p>
*/
protected void encodeBegin(Node node, ElementBean target, ComponentBean
root) {
super.encodeBegin(node, target, root);
@@ -64,8 +65,10 @@
}
/**
- * <p>Recursively traverses the children of the HTML [EMAIL PROTECTED]
Node} concatenating
- * the raw text of each [EMAIL PROTECTED] Token} into the
<code>commentBody</code>.</p>
+ * <p>Recursively traverses the children of the HTML
+ * [EMAIL PROTECTED] org.apache.shale.clay.parser.Node} concatenating
+ * the raw text of each [EMAIL PROTECTED]
org.apache.shale.clay.parser.Token}
+ * into the <code>commentBody</code>.</p>
*/
protected void captureComment(Node node, StringBuffer commentBody) {
Iterator ni = node.getChildren().iterator();
@@ -79,8 +82,7 @@
/**
* <p>This override cancels the super implementation. The overridden
- * <code>encodeBegin(Node, ElementBean, ComponentBean) method handles
- * the ending comment tag, "-->".</p>
+ * method handles the ending comment tag, "-->".</p>
*/
protected void encodeEnd(Node node, ElementBean target, ComponentBean
root) {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/MorphBuilder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/MorphBuilder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/MorphBuilder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/MorphBuilder.java
Mon Aug 29 21:37:46 2005
@@ -28,8 +28,8 @@
* component defined by the <code>jsfid</code> attribute in the HTML element.
* For most of the builder there is an assumed mapping between the source and
* target but the HTML span can be mapped to any clay meta component graph. The
- * [EMAIL PROTECTED] SpanBuilderRule} handle the association of the HTML node
with this
- * class.
+ * [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.chain.SpanBuilderRule} handle
+ * the association of the HTML node with this class.
* </p>
*/
public class MorphBuilder extends Builder {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectManyMenuBuilder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectManyMenuBuilder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectManyMenuBuilder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectManyMenuBuilder.java
Mon Aug 29 21:37:46 2005
@@ -24,9 +24,10 @@
/**
* <p>
- * This [EMAIL PROTECTED] Builder} creates a [EMAIL PROTECTED] ElementBean}
mapped to a html select
- * [EMAIL PROTECTED] Node} by the [EMAIL PROTECTED] SelectBuilderRule}. The
JSF component type for a
- * multi-select is <code>javax.faces.HtmlSelectManyMenu</code>
+ * This [EMAIL PROTECTED] Builder} creates a [EMAIL PROTECTED]
org.apache.shale.clay.config.beans.ElementBean}
+ * mapped to a html select [EMAIL PROTECTED]
org.apache.shale.clay.parser.Node} by the
+ * [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.chain.SelectBuilderRule}. The JSF
component
+ * type for a multi-select is <code>javax.faces.HtmlSelectManyMenu</code>
* <p>
*/
public class SelectManyMenuBuilder extends Builder {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneMenuBuilder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneMenuBuilder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneMenuBuilder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneMenuBuilder.java
Mon Aug 29 21:37:46 2005
@@ -24,9 +24,11 @@
/**
* <p>
- * This [EMAIL PROTECTED] Builder} will create a target [EMAIL PROTECTED]
ElementBean} for a single
- * select html [EMAIL PROTECTED] Node}. The mapping between the html and the
builder is
- * handled by the [EMAIL PROTECTED] SelectBuilderRule}.
+ * This [EMAIL PROTECTED] Builder} will create a target
+ * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean} for a
single
+ * select html [EMAIL PROTECTED] org.apache.shale.clay.parser.Node}. The
mapping between the
+ * html and the builder is handled by the
+ * [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.chain.SelectBuilderRule}.
* </p>
*/
public class SelectOneMenuBuilder extends Builder {
@@ -55,7 +57,7 @@
/**
* <p>
* Returns the <code>jsfid</code> that will populate the target
- * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}
+ * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}.
* </p>
*/
protected String getJsfid(Node node) {
@@ -65,7 +67,7 @@
/**
* <p>
* Returns a <code>true</code> value indicating that the target JSF
- * component can have children
+ * component can have children.
* </p>
*/
public boolean isChildrenAllowed() {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneRadioBuilder.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneRadioBuilder.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneRadioBuilder.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/SelectOneRadioBuilder.java
Mon Aug 29 21:37:46 2005
@@ -24,16 +24,17 @@
/**
* <p>
- * This [EMAIL PROTECTED] Builder} will create a target [EMAIL PROTECTED]
ElementBean} for a single
+ * This [EMAIL PROTECTED] Builder} will create a target {
+ * @link org.apache.shale.clay.config.beans.ElementBean} for a single
* input radio [EMAIL PROTECTED] Node}. The mapping between the html and the
builder is
- * handled by the [EMAIL PROTECTED] InputBuilderRule}.
+ * handled by the [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.chain.InputBuilderRule}.
* </p>
*/
public class SelectOneRadioBuilder extends Builder {
/**
* <p>
- * Common logger utility class
+ * Common logger utility class.
* </p>
*/
private static Log log;
@@ -44,7 +45,7 @@
/**
* <p>
* Returns a JSF component type of
- * <code>javax.faces.HtmlSelectOneRadio</code>
+ * <code>javax.faces.HtmlSelectOneRadio</code>.
* </p>
*/
protected String getComponentType(Node node) {
@@ -54,7 +55,7 @@
/**
* <p>
* Returns a <code>jsfid</code> that will populate the target
- * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}
+ * [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}.
* </p>
*/
protected String getJsfid(Node node) {
@@ -64,7 +65,7 @@
/**
* <p>
* Returns <code>true</code> meaning that the target JSF component can
- * have children
+ * have children.
* </p>
*/
public boolean isChildrenAllowed() {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/BuilderRuleContext.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/BuilderRuleContext.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/BuilderRuleContext.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/BuilderRuleContext.java
Mon Aug 29 21:37:46 2005
@@ -24,23 +24,25 @@
/**
* <p>
- * This context is used by the [EMAIL PROTECTED] BuilderFactor} to invoke the
- * <code>Globals.FIND_BUILDER_COMMAND_NAME</code> chain passing this context.
- * When the chain has stopped, the context will contain the [EMAIL PROTECTED]
Builder}
- * needed to convert the html [EMAIL PROTECTED] Node} into a [EMAIL PROTECTED]
ElementBean}.
+ * This context is used by the [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.BuilderFactory}
+ * to invoke the <code>Globals.FIND_BUILDER_COMMAND_NAME</code> chain passing
this context.
+ * When the chain has stopped, the context will contain the
+ * [EMAIL PROTECTED] org.apache.shale.clay.parser.builder.Builder}
+ * needed to convert the html [EMAIL PROTECTED]
org.apache.shale.clay.parser.Node}
+ * into a [EMAIL PROTECTED] org.apache.shale.clay.config.beans.ElementBean}.
*/
public class BuilderRuleContext extends ContextBase {
/**
* <p>
- * Current html node
+ * The current html node.
* </p>
*/
private Node node = null;
/**
* <p>
- * Returns the current html [EMAIL PROTECTED] Node}
+ * Returns the current html [EMAIL PROTECTED]
org.apache.shale.clay.parser.Node}.
* </p>
*/
public Node getNode() {
@@ -49,7 +51,7 @@
/**
* <p>
- * Sets the current html [EMAIL PROTECTED] Node}
+ * Sets the current html [EMAIL PROTECTED]
org.apache.shale.clay.parser.Node}.
* </p>
*/
public void setNode(Node node) {
@@ -65,7 +67,7 @@
/**
* <p>
- * Returns the target [EMAIL PROTECTED] Builder}
+ * Returns the target [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.Builder}.
* </p>
*/
public Builder getBuilder() {
@@ -74,7 +76,7 @@
/**
* <p>
- * Sets the target [EMAIL PROTECTED] Builder}
+ * Sets the target [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.Builder}.
* </p>
*/
public void setBuilder(Builder builder) {
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/DefaultBuilderRule.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/DefaultBuilderRule.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/DefaultBuilderRule.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/DefaultBuilderRule.java
Mon Aug 29 21:37:46 2005
@@ -53,7 +53,7 @@
* [EMAIL PROTECTED] org.apache.shale.clay.parser.Node}. This is the
default rule that
* will return a [EMAIL PROTECTED] VerbatimBuilder} when the node is not a
comment.
* When the html node is the start of a comment, the [EMAIL PROTECTED]
CommentBuilder}
- * with handle creating the correct [EMAIL PROTECTED]
org.apache.shale.config.beans.ElementBean}
+ * with handle creating the correct [EMAIL PROTECTED]
org.apache.shale.clay.config.beans.ElementBean}
* used to create a faces component.
* </p>
*/
Modified:
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/SelectBuilderRule.java
URL:
http://svn.apache.org/viewcvs/struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/SelectBuilderRule.java?rev=264702&r1=264701&r2=264702&view=diff
==============================================================================
---
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/SelectBuilderRule.java
(original)
+++
struts/shale/trunk/clay-plugin/src/java/org/apache/shale/clay/parser/builder/chain/SelectBuilderRule.java
Mon Aug 29 21:37:46 2005
@@ -27,15 +27,16 @@
/**
* <p>
- * This rule will map a html select [EMAIL PROTECTED] Node} to a [EMAIL
PROTECTED] SelectOneBuilder}
- * or a [EMAIL PROTECTED] SelectManyMenuBuilder}.
+ * This rule will map a html select [EMAIL PROTECTED] Node} to a
+ * [EMAIL PROTECTED] org.apache.shale.clay.parser.builder.SelectOneMenuBuilder}
+ * or a [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.SelectManyMenuBuilder}.
* </p>
*/
public class SelectBuilderRule implements Command {
/**
* <p>
- * Array of target [EMAIL PROTECTED] Builder}s
+ * An array of target [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.Builder}s.
* </p>
*/
private static final Builder[] builders = { new SelectOneMenuBuilder(),
@@ -43,8 +44,8 @@
/**
* <pReturns <code>true</code> if a match was made from a select
- * [EMAIL PROTECTED] Node} to a [EMAIL PROTECTED] SelectOneMenuBuilder} or
a
- * [EMAIL PROTECTED] SelectManyMenuBuilder}.
+ * [EMAIL PROTECTED] Node} to a [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.SelectOneMenuBuilder}
+ * or a [EMAIL PROTECTED]
org.apache.shale.clay.parser.builder.SelectManyMenuBuilder}.
* <p>
*/
public boolean execute(Context context) throws Exception {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
