Author: hlship
Date: Tue Jun 7 01:22:48 2011
New Revision: 1132849
URL: http://svn.apache.org/viewvc?rev=1132849&view=rev
Log:
TAP5-1528: Add @tapestrydoc annotations to component classes
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Checkbox.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.xdoc
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Delegate.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Errors.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/EventLink.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.xdoc
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.java
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.xdoc
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Checkbox.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Checkbox.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Checkbox.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Checkbox.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -25,6 +25,8 @@ import org.apache.tapestry5.services.Req
/**
* A Checkbox component is simply a <input type="checkbox">.
+ *
+ * @tapestrydoc
*/
public class Checkbox extends AbstractField
{
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2009, 2010 The Apache Software Foundation
+// Copyright 2007, 2008, 2009, 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -45,6 +45,10 @@ import org.apache.tapestry5.services.jav
* <p/>
* Tapestry's DateField component is a wrapper around <a
* href="http://webfx.eae.net/dhtml/datepicker/datepicker.html";>WebFX
DatePicker</a>.
+ *
+ * @tapestrydoc
+ * @see Form
+ * @see TextField
*/
// TODO: More testing; see https://issues.apache.org/jira/browse/TAPESTRY-1844
@Import(stack = "core-datefield")
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.xdoc
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.xdoc?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.xdoc
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/DateField.xdoc
Tue Jun 7 01:22:48 2011
@@ -1,17 +1,6 @@
<document>
<body>
- <section name="Related Components">
- <ul>
- <li>
- <a href="Form.html">Form</a>
- </li>
- <li>
- <a href="TextField.html">TextField</a>
- </li>
- </ul>
- </section>
-
<section name="Examples">
<p>
The DateField component is very easy to use, all the
JavaScript is generated for you. Then end result
@@ -56,19 +45,11 @@
<p>
The use of the extra <div> elements is to trigger the
CSS styles that are
- usually used as part of a<a
href="BeanEditForm.html">BeanEditForm</a>. Just the
+ usually used as part of a <a
href="BeanEditForm.html">BeanEditForm</a>. Just the
<code><![CDATA[<t:datefield>]]></code>
element is all that's really necessary.
</p>
</section>
- <section name="Notes">
-
- <p>The DateField component is based on the open source
- <a
href="http://webfx.eae.net/dhtml/datepicker/usage.html";>WebFX DatePicker</a>
- widget.
- </p>
-
- </section>
</body>
</document>
\ No newline at end of file
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Delegate.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Delegate.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Delegate.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Delegate.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008 The Apache Software Foundation
+// Copyright 2007, 2008, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -31,7 +31,9 @@ import org.apache.tapestry5.runtime.Comp
* and use Delegate multiple times in the template to render the block passing
parameters to Delegate. In the block body
* reference the render variables using the "var:" binding prefix and the name
of the parameter.
* <p>
- * Note that the default binding prefix for parameter values is "literal".
+ * Note that the default binding prefix for informal parameter values is
"literal".
+ *
+ * @tapestrydoc
*/
@SupportsInformalParameters
public class Delegate
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Errors.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Errors.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Errors.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Errors.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -30,6 +30,9 @@ import java.util.List;
* div element around a banner message and around an unnumbered list of
* error messages. Renders nothing if the {@link
org.apache.tapestry5.ValidationTracker} shows no
* errors.
+ *
+ * @see Form
+ * @tapestrydoc
*/
public class Errors
{
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/EventLink.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/EventLink.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/EventLink.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/EventLink.java
Tue Jun 7 01:22:48 2011
@@ -30,6 +30,7 @@ import org.apache.tapestry5.ioc.annotati
* <p/>
* This allows slightly shorter URLs but also allows multiple components
within the same container to generate identical
* URLs for common actions.
+ * @tapestrydoc
*/
public class EventLink extends AbstractComponentEventLink
{
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2008, 2009, 2010 The Apache Software Foundation
+// Copyright 2008, 2009, 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@ import org.apache.tapestry5.annotations.
import org.apache.tapestry5.corelib.internal.ComponentActionSink;
import org.apache.tapestry5.corelib.internal.FormSupportAdapter;
import org.apache.tapestry5.corelib.internal.HiddenFieldPositioner;
+import org.apache.tapestry5.corelib.mixins.TriggerFragment;
import org.apache.tapestry5.dom.Element;
import org.apache.tapestry5.ioc.annotations.Inject;
import org.apache.tapestry5.services.ClientBehaviorSupport;
@@ -54,7 +55,9 @@ import org.slf4j.Logger;
* <dd>Hides the element, then removes it from the DOM entirely.
* </dl>
*
- * @see org.apache.tapestry5.corelib.mixins.TriggerFragment
+ * @see TriggerFragment
+ * @see Form
+ * @tapestrydoc
*/
@SupportsInformalParameters
public class FormFragment implements ClientElement
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.xdoc
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.xdoc?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.xdoc
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/FormFragment.xdoc
Tue Jun 7 01:22:48 2011
@@ -1,17 +1,6 @@
<document>
<body>
- <section name="Related Components">
-
- <ul>
- <li>
- <a href="Form.html">Form</a>
- </li>
- <li>
- <a
href="../mixins/TriggerFragment.html">TriggerFragment</a>
- </li>
- </ul>
- </section>
-
+
<section name="Examples">
<p>
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.java?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.java
Tue Jun 7 01:22:48 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2009, 2010 The Apache Software Foundation
+// Copyright 2007, 2008, 2009, 2010, 2011 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -25,7 +25,6 @@ import org.apache.tapestry5.ComponentAct
import org.apache.tapestry5.ComponentResources;
import org.apache.tapestry5.MarkupWriter;
import org.apache.tapestry5.PropertyOverrides;
-import org.apache.tapestry5.RenderSupport;
import org.apache.tapestry5.ValueEncoder;
import org.apache.tapestry5.annotations.Component;
import org.apache.tapestry5.annotations.Environmental;
@@ -51,7 +50,6 @@ import org.apache.tapestry5.services.Cli
import org.apache.tapestry5.services.ComponentDefaultProvider;
import org.apache.tapestry5.services.ComponentEventResultProcessor;
import org.apache.tapestry5.services.FormSupport;
-import org.apache.tapestry5.services.Request;
import org.apache.tapestry5.services.javascript.JavaScriptSupport;
/**
@@ -68,6 +66,10 @@ import org.apache.tapestry5.services.jav
* @see org.apache.tapestry5.beaneditor.BeanModel
* @see org.apache.tapestry5.services.BeanModelSource
* @see org.apache.tapestry5.grid.GridDataSource
+ * @tapestrydoc
+ * @see BeanEditForm
+ * @see BeanDisplay
+ * @see Loop
*/
@SupportsInformalParameters
public class Grid implements GridModel
Modified:
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.xdoc
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.xdoc?rev=1132849&r1=1132848&r2=1132849&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.xdoc
(original)
+++
tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/Grid.xdoc
Tue Jun 7 01:22:48 2011
@@ -1,18 +1,6 @@
<document>
<body>
- <section name="Related Components">
- <ul>
- <li>
- <a href="BeanEditForm.html">BeanEditForm</a>
- </li>
- <li>
- <a href="BeanDisplay.html">BeanDisplay</a>
- </li>
- <li>
- <a href="Loop.html"></a>
- </li>
- </ul>
- </section>
+
<section name="Simple Example">
