You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/05/14 19:25:43 UTC
svn commit: r170147 - in /incubator/beehive/trunk/netui/src:
pageflow/org/apache/beehive/netui/pageflow/annotations/
tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/
tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/
tags-html/org/apache/beehive/netui/tags/html/
tags-html/org/apache/beehive/netui/tags/internal/
tags-html/org/apache/beehive/netui/tags/rendering/
util/org/apache/beehive/netui/util/iterator/
Author: ekoneil
Date: Sat May 14 10:25:41 2005
New Revision: 170147
URL: http://svn.apache.org/viewcvs?rev=170147&view=rev
Log:
NetUI Javadoc fixes.
Correct all warnings produced during a <javadoc> run by the netui "ant docs" target.
BB: self
DRT: NetUI pass
Modified:
incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/annotations/Jpf.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/DataGridTagModel.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/Sort.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortDirection.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortModel.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/internal/PageFlowTagUtils.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/rendering/StringBuilderRenderAppender.java
incubator/beehive/trunk/netui/src/util/org/apache/beehive/netui/util/iterator/IteratorFactory.java
Modified: incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/annotations/Jpf.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/annotations/Jpf.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/annotations/Jpf.java (original)
+++ incubator/beehive/trunk/netui/src/pageflow/org/apache/beehive/netui/pageflow/annotations/Jpf.java Sat May 14 10:25:41 2005
@@ -572,7 +572,7 @@
/**
* The type of form bean to use for this action. A new instance of the given class will be created when this
- * action is run. Mutually exclusive with {@link #useFormbean}.
+ * action is run. Mutually exclusive with {@link #useFormBean}.
*/
Class useFormBeanType() default Void.class;
@@ -1578,7 +1578,7 @@
String displayName() default "";
/**
- * A key in the default message bundle or in the bundle specified by {@link #bundleName} that will be
+ * A key in the default message bundle or in the bundle specified by {@link MessageBundle#bundleName} that will be
* used as the first argument to all error messages for this property. When this is specified,
* the individual rules can avoid providing specific messages; instead, a default message will be used.
* Mutually-exclusive with {@link #displayName}.
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/DataGridTagModel.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/DataGridTagModel.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/DataGridTagModel.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/rendering/DataGridTagModel.java Sat May 14 10:25:41 2005
@@ -137,12 +137,12 @@
* affect their behavior based on the data grid's current render state. This value will
* be one of:
* <ul>
- * <li>{@link DataGridTagModel.RENDER_STATE_START}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_CAPTION}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_HEADER}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_GRID}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_FOOTER}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_END}</li>
+ * <li>{@link #RENDER_STATE_START}</li>
+ * <li>{@link #RENDER_STATE_CAPTION}</li>
+ * <li>{@link #RENDER_STATE_HEADER}</li>
+ * <li>{@link #RENDER_STATE_GRID}</li>
+ * <li>{@link #RENDER_STATE_FOOTER}</li>
+ * <li>{@link #RENDER_STATE_END}</li>
* </ul>
* </p>
*
@@ -158,12 +158,12 @@
* the provided render state value is unknown, an {@link IllegalStateException} is thrown. The
* data grid cycles through its state in this order:
* <ul>
- * <li>{@link DataGridTagModel.RENDER_STATE_START}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_CAPTION}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_HEADER}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_GRID}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_FOOTER}</li>
- * <li>{@link DataGridTagModel.RENDER_STATE_END}</li>
+ * <li>{@link #RENDER_STATE_START}</li>
+ * <li>{@link #RENDER_STATE_CAPTION}</li>
+ * <li>{@link #RENDER_STATE_HEADER}</li>
+ * <li>{@link #RENDER_STATE_GRID}</li>
+ * <li>{@link #RENDER_STATE_FOOTER}</li>
+ * <li>{@link #RENDER_STATE_END}</li>
* </ul>
* </p>
*
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/Sort.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/Sort.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/Sort.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/Sort.java Sat May 14 10:25:41 2005
@@ -26,7 +26,7 @@
* <p>
* A Sort object can be used by some sorting infrastructure to either parameterise a SQL or XQuery
* query or to simply sort in-memory Java objects. For example, when converting a Sort into
- * a SQL fragment, a Sort with sortExpression "foo" and sortDirection {@link SortDirection.DESCENDING} could
+ * a SQL fragment, a Sort with sortExpression "foo" and sortDirection {@link SortDirection#DESCENDING} could
* be converted into:
* <pre>
* ORDER BY FOO DESC
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortDirection.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortDirection.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortDirection.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortDirection.java Sat May 14 10:25:41 2005
@@ -20,8 +20,8 @@
/**
* <p>
* The SortDirection class is an abstract representation of the direction of a sort. This class
- * is able to represent a sort that is either {@link SortDirection.ASCENDING}, {@link SortDirection.DESCENDING},
- * or {@link SortDirection.NONE}.
+ * is able to represent a sort that is either {@link #ASCENDING}, {@link #DESCENDING},
+ * or {@link #NONE}.
* </p>
* <p>
* The SortDirection class should be used to specify the direction of a sort on a {@link Sort} instance.
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortModel.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortModel.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortModel.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/sort/SortModel.java Sat May 14 10:25:41 2005
@@ -36,11 +36,10 @@
* In addition to accessing the Sort objects, the SortModel provides a the ability to plug a simple state
* machine that controls how to change a sort direction when cycling through the set of sort directions.
* For example, when using a data grid to sort columns of data, a column may start off unsorted,
- * change to {@link org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection.ASCENDING}, to
- * {@link org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection.DESCENDING}, and finally back to
- * {@link SortDirection.NONE}. The {@link SortStrategy} allows this strategy to be changed so that the
- * sorts can change from {@link SortDirection.NONE} to {@link SortDirection.DESCENDING}, to
- * {@link SortDirection.ASCENDING}, and finally back to {@link SortDirection.NONE}.
+ * change to {@link SortDirection#ASCENDING}, to {@link SortDirection#DESCENDING}, and finally back to
+ * {@link SortDirection#NONE}. The {@link SortStrategy} allows this strategy to be changed so that the
+ * sorts can change from {@link SortDirection#NONE} to {@link SortDirection#DESCENDING}, to
+ * {@link SortDirection#ASCENDING}, and finally back to {@link SortDirection#NONE}.
* </p>
*/
public class SortModel
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java Sat May 14 10:25:41 2005
@@ -347,8 +347,8 @@
}
/**
- * return <code>true</code> if focucs has been set.
- * @return
+ * Get the focus flag.
+ * @return <code>true</code> if the focus has been set. <code>false</code> otherwise.
*/
public boolean isFocusSet() {
return (_focus != null);
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java Sat May 14 10:25:41 2005
@@ -136,8 +136,8 @@
}
/**
- * return the password <code>boolean</code> value.
- * @return
+ * Get the password state.
+ * @return <code>true</code> if the text box is used for passwords. <code>false</code> otherwise.
*/
protected boolean getPassword()
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/internal/PageFlowTagUtils.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/internal/PageFlowTagUtils.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/internal/PageFlowTagUtils.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/internal/PageFlowTagUtils.java Sat May 14 10:25:41 2005
@@ -49,7 +49,7 @@
/**
* Create a fully-rewritten url from an initial action url with query parameters
* and an anchor (location on page), checking if it needs to be secure then call
- * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLRewriter.URLType#ACTION}.
+ * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLType#ACTION}.
* @param pageContext the current PageContext.
* @param action the action url to rewrite.
* @param params the query parameters for this url.
@@ -70,7 +70,7 @@
/**
* Create a fully-rewritten url from an initial href url with query parameters
* and an anchor (location on page), checking if it needs to be secure then call
- * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLRewriter.URLType#ACTION}.
+ * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLType#ACTION}.
* @param pageContext the current PageContext.
* @param url the href url to rewrite.
* @param params the query parameters for this url.
@@ -92,7 +92,7 @@
/**
* Create a fully-rewritten url from an initial resource url with query parameters
* and an anchor (location on page), checking if it needs to be secure then call
- * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLRewriter.URLType#RESOURCE}.
+ * the rewriter service using a type of {@link org.apache.beehive.netui.core.urls.URLType#RESOURCE}.
* @param pageContext the current PageContext.
* @param url the resource url to rewrite.
* @param params the query parameters for this url.
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/rendering/StringBuilderRenderAppender.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/rendering/StringBuilderRenderAppender.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/rendering/StringBuilderRenderAppender.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/rendering/StringBuilderRenderAppender.java Sat May 14 10:25:41 2005
@@ -21,10 +21,10 @@
/**
* This is an implementation of {@link AbstractRenderAppender} which appends
- * Strings to a {@link java.lang.InternalStringBuilder}
+ * Strings to a {@link InternalStringBuilder}
*/
public class StringBuilderRenderAppender
- extends AbstractRenderAppender
+ extends AbstractRenderAppender
{
private InternalStringBuilder _sb;
@@ -56,6 +56,7 @@
public String toString()
{
+ assert _sb != null : "Render appender doesn't have a valid string builder";
return _sb.toString();
}
}
Modified: incubator/beehive/trunk/netui/src/util/org/apache/beehive/netui/util/iterator/IteratorFactory.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/util/org/apache/beehive/netui/util/iterator/IteratorFactory.java?rev=170147&r1=170146&r2=170147&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/util/org/apache/beehive/netui/util/iterator/IteratorFactory.java (original)
+++ incubator/beehive/trunk/netui/src/util/org/apache/beehive/netui/util/iterator/IteratorFactory.java Sat May 14 10:25:41 2005
@@ -36,7 +36,7 @@
* This class provides a factory that can create an {@link Iterator} for various types
* of Java objects. Supported types include:
* <ul>
- * <li>{@link java.util.Iterator</li>
+ * <li>{@link java.util.Iterator}</li>
* <li>{@link java.util.Collection}</li>
* <li>{@link java.util.Map}</li>
* <li>{@link java.sql.ResultSet}</li>