You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2011/06/07 03:22:44 UTC

svn commit: r1132848 - /tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/

Author: hlship
Date: Tue Jun  7 01:22:44 2011
New Revision: 1132848

URL: http://svn.apache.org/viewvc?rev=1132848&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/ActionLink.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.xdoc
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.xdoc
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.xdoc
    tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/ActionLink.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/ActionLink.java?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/ActionLink.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/ActionLink.java Tue Jun  7 01:22:44 2011
@@ -1,4 +1,4 @@
-// Copyright 2006, 2007, 2008, 2009 The Apache Software Foundation
+// Copyright 2006, 2007, 2008, 2009, 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.
@@ -23,6 +23,8 @@ import org.apache.tapestry5.ioc.annotati
 
 /**
  * Component that triggers an action on the server with a subsequent full page refresh.
+ * 
+ * @tapestrydoc
  */
 @Events(EventConstants.ACTION)
 public class ActionLink extends AbstractComponentEventLink

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.java?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.java Tue Jun  7 01:22:44 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.
@@ -53,6 +53,11 @@ import org.apache.tapestry5.services.jav
  * 
  * @see EventConstants#ADD_ROW
  * @see EventConstants#REMOVE_ROW
+ * @tapestrydoc
+ * @see AddRowLink
+ * @see RemoveRowLink
+ * @see Loop
+ * @see FormInjector
  */
 @Events(
 { EventConstants.ADD_ROW, EventConstants.REMOVE_ROW })

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.xdoc
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.xdoc?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.xdoc (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/AjaxFormLoop.xdoc Tue Jun  7 01:22:44 2011
@@ -1,23 +1,5 @@
 <document>
     <body>
-        <section name="Related Components">
-
-            <ul>
-                <li>
-                    <a href="AddRowLink.html">AddRowLink</a>
-                </li>
-                <li>
-                    <a href="RemoveRowLink.html">RemoveRowLink</a>
-                </li>
-                <li>
-                    <a href="Loop.html">Loop</a>
-                </li>
-                <li>
-                    <a href="FormInjector.html">FormInjector</a>
-                </li>
-            </ul>
-        </section>
-
         <section name="Examples">
 
             <p>

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java Tue Jun  7 01:22:44 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2010 The Apache Software Foundation
+// Copyright 2007, 2008, 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.
@@ -38,6 +38,9 @@ import org.apache.tapestry5.services.Bea
  * 
  * @see org.apache.tapestry5.beaneditor.DataType
  * @see BeanModel
+ * @tapestrydoc
+ * @see BeanEditForm
+ * @see Grid
  */
 @SupportsInformalParameters
 public class BeanDisplay

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.xdoc
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.xdoc?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.xdoc (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.xdoc Tue Jun  7 01:22:44 2011
@@ -1,19 +1,6 @@
 <document>
     <body>
 
-        <section name="Related Components">
-
-            <ul>
-                <li>
-                    <a href="BeanEditForm.html">BeanEditForm</a>
-                </li>
-                <li>
-                    <a href="Grid.html">Grid</a>
-                </li>
-            </ul>
-
-        </section>
-
         <section name="Examples">
 
             <p>

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java Tue Jun  7 01:22:44 2011
@@ -55,6 +55,9 @@ import org.apache.tapestry5.services.Bea
  * @see org.apache.tapestry5.corelib.components.PropertyEditor
  * @see org.apache.tapestry5.beaneditor.DataType
  * @tapestrydoc
+ * @see Form
+ * @see Errors
+ * @see BeanEditor
  */
 @SupportsInformalParameters
 @Events(EventConstants.PREPARE)

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.xdoc
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.xdoc?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.xdoc (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.xdoc Tue Jun  7 01:22:44 2011
@@ -1,13 +1,6 @@
 <document>
     <body>
 
-        <p>
-            The BeanEditForm component is a convienent wrapper around three components:
-            <a href="Form.html">Form</a>,
-            <a href="Errors.html">Errors</a>
-            and
-            <a href="BeanEditor.html">BeanEditor</a>.
-        </p>
 
 
         <section name="Related Components">

Modified: tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java?rev=1132848&r1=1132847&r2=1132848&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java (original)
+++ tapestry/tapestry5/trunk/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java Tue Jun  7 01:22:44 2011
@@ -1,4 +1,4 @@
-// Copyright 2007, 2008, 2010 The Apache Software Foundation
+// Copyright 2007, 2008, 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.
@@ -40,6 +40,8 @@ import java.lang.annotation.Annotation;
  * A component that generates a user interface for editing the properties of a bean. This is the central component of
  * the {@link BeanEditForm}, and utilizes a {@link PropertyEditor} for much of its functionality. This component places
  * a {@link BeanEditContext} into the environment.
+ * 
+ * @tapestrydoc
  */
 @SupportsInformalParameters
 public class BeanEditor
@@ -207,8 +209,8 @@ public class BeanEditor
             }
             catch (Exception ex)
             {
-                String message = InternalMessages.failureInstantiatingObject(model.getBeanType(), resources
-                        .getCompleteId(), ex);
+                String message = InternalMessages.failureInstantiatingObject(model.getBeanType(),
+                        resources.getCompleteId(), ex);
                 throw new TapestryException(message, resources.getLocation(), ex);
             }