You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by bo...@apache.org on 2007/07/31 08:06:27 UTC
svn commit: r561237 - in /myfaces/tobago/trunk:
core/src/main/java/org/apache/myfaces/tobago/taglib/component/
core/src/main/java/org/apache/myfaces/tobago/taglib/decl/
core/src/main/java/org/apache/myfaces/tobago/taglib/extension/
tobago-tool/tobago-t...
Author: bommel
Date: Mon Jul 30 23:06:26 2007
New Revision: 561237
URL: http://svn.apache.org/viewvc?view=rev&rev=561237
Log:
improved documentation
Modified:
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ForEachTag.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/LinkTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/MenuBarTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/SheetTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ToolBarTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeListboxTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeOldTagDeclaration.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasIdReference.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasNameReference.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/DateExtensionTag.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/InExtensionTag.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TextAreaExtensionTag.java
myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TimeExtensionTag.java
myfaces/tobago/trunk/tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/TaglibAnnotationVisitor.java
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ForEachTag.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ForEachTag.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ForEachTag.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ForEachTag.java Mon Jul 30 23:06:26 2007
@@ -37,10 +37,10 @@
import java.util.regex.Pattern;
/**
- * Replacement for the JSTL <c:foreach> tag. <br>
+ * Replacement for the JSTL <c:foreach> tag. <br />
* This tags iterates over the body content without setting up an exported
* scope variable, but replaces all occurrence's of <code>var</code> in
- * <code>TobagoTag's ValueBinding</code> attributes.<br>
+ * <code>TobagoTag's ValueBinding</code> attributes.<br />
* All non TobagoTags are treated as they are, no
* replacement is done, and so no ability to use the <code>var</code> in el.
*/
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/LinkTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/LinkTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/LinkTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/LinkTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -40,6 +40,7 @@
/**
* Renders a link element.
+ *
*/
@Tag(name = "link", tagExtraInfoClassName = "org.apache.myfaces.tobago.taglib.component.CommandTagExtraInfo")
@BodyContentDescription(anyTagOf = "facestag")
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/MenuBarTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/MenuBarTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/MenuBarTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/MenuBarTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -30,9 +30,9 @@
* Time: 17:14:12
*/
/*
- * Renders a menu bar.<br>
+ * Renders a menu bar.<br />
* Add menu bar as facet name="menuBar" to page tag or use it anywhere
- * on page.<br>
+ * on page.<br />
*/
@Tag(name = "menuBar")
@BodyContentDescription(
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/SheetTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/SheetTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/SheetTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/SheetTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -47,7 +47,7 @@
public interface SheetTagDeclaration extends TobagoTagDeclaration, HasIdBindingAndRendered {
/**
* LayoutConstraints for column layout.
- * Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').
+ * Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%').
*/
@TagAttribute(required = true)
@UIComponentTagAttribute()
@@ -121,7 +121,7 @@
/**
* Flag indicating whether or not this sheet should reserve space for
- * vertical toolbar when calculating column width's.<br>
+ * vertical toolbar when calculating column width's.<br />
* Possible values are: <pre>
* 'auto' : sheet try to estimate the need of scrollbar,
* this is the default.
@@ -175,7 +175,7 @@
/**
* Flag indicating whether or not the sheet should be selectable <br />
* Valid values are <strong>none</strong>, <strong>single</strong>,
- * and <strong>multi</strong>.<br/>
+ * and <strong>multi</strong>.<br />
* The <strong>default</strong> is <code>multi</code>.
*/
@TagAttribute
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ToolBarTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ToolBarTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ToolBarTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/ToolBarTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -32,12 +32,12 @@
*/
/**
- * <p/>
- * Renders a toolbar.<p>
+ * <p />
+ * Renders a toolbar.<p />
* Allowed subcomponents are subtypes of UICommand i.e.
* <code>'button'</code> and <code>'link'</code> tags.
* These are rendered by ToolbarRenderer, so the result has
- * no difference.<p>
+ * no difference.<p />
* To add an dropdown menu to a button add a facet <code>'menupopup'</code>
* containing a
* <a href="../tobago/menu.html"><code><tc:menu></code></a>
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeListboxTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeListboxTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeListboxTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeListboxTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -52,11 +52,11 @@
* Flag indicating whether or not this component should be render selectable items.
* Possible values are:
* <ul>
- * <li><strong>single</strong> : a singleselection tree is rendered
+ * <li><strong>single</strong> : a singleselection tree is rendered</li>
* <li><strong>singleLeafOnly</strong> : a singleselection tree is rendered,
- * only Leaf's are selectable
+ * only Leaf's are selectable</li>
* <li><strong>siblingLeafOnly</strong> : a multiselection tree is rendered,
- * where only sibling Leaf's are selectable
+ * where only sibling Leaf's are selectable</li>
* </ul>
*/
@TagAttribute
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeOldTagDeclaration.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeOldTagDeclaration.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeOldTagDeclaration.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/component/TreeOldTagDeclaration.java Mon Jul 30 23:06:26 2007
@@ -47,12 +47,12 @@
* Flag indicating whether or not this component should be render selectable items.
* Possible values are:
* <ul>
- * <li><strong>multi</strong> : a multisection tree is rendered
- * <li><strong>single</strong> : a singlesection tree is rendered
+ * <li><strong>multi</strong> : a multisection tree is rendered</li>
+ * <li><strong>single</strong> : a singlesection tree is rendered</li>
* <li><strong>multiLeafOnly</strong> : a multisection tree is rendered,
- * only Leaf's are selectable
+ * only Leaf's are selectable</li>
* <li><strong>singleLeafOnly</strong> : a singlesection tree is rendered,
- * only Leaf's are selectable
+ * only Leaf's are selectable</li>
* </ul>
* For any other value or if this attribute is omited the items are not selectable.
*/
@@ -87,10 +87,10 @@
void setShowRoot(String showRoot);
/**
- * Bean property reference to fetch the disabled state for the treeNode's.<br>
- * Example:<br>
+ * Bean property reference to fetch the disabled state for the treeNode's.<br />
+ * Example:<br />
* a disabledReference="userObject.disabled" try's to invoke
- * <code><UITreeNode>.getUserObject().getDisabled()<code> to fetch the state.
+ * <code><UITreeNode>.getUserObject().getDisabled()</code> to fetch the state.
*/
@TagAttribute
@UIComponentTagAttribute()
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasIdReference.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasIdReference.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasIdReference.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasIdReference.java Mon Jul 30 23:06:26 2007
@@ -25,10 +25,10 @@
*/
public interface HasIdReference {
/**
- * Bean property reference to fetch the id for the treeNode's.<br>
- * Example:<br>
+ * Bean property reference to fetch the id for the treeNode's.<br />
+ * Example:<br />
* a idReference="userObject.id" try's to invoke
- * <code><UITreeNode>.getUserObject().getId()<code> to fetch the id.
+ * <code><UITreeNode>.getUserObject().getId()</code> to fetch the id.
*
*/
@TagAttribute @UIComponentTagAttribute()
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasNameReference.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasNameReference.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasNameReference.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/decl/HasNameReference.java Mon Jul 30 23:06:26 2007
@@ -25,10 +25,10 @@
*/
public interface HasNameReference {
/**
- * Bean property reference to fetch the label for the treeNode's.<br>
- * Example:<br>
+ * Bean property reference to fetch the label for the treeNode's.<br />
+ * Example:<br />
* a idReference="userObject.name" try's to invoke
- * <code><UITreeNode>.getUserObject().getName()<code> to fetch the label.
+ * <code><UITreeNode>.getUserObject().getName()</code> to fetch the label.
*
*/
@TagAttribute @UIComponentTagAttribute()
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/DateExtensionTag.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/DateExtensionTag.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/DateExtensionTag.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/DateExtensionTag.java Mon Jul 30 23:06:26 2007
@@ -48,7 +48,7 @@
*/
/**
* Renders a date input field with a date picker and a label.
- * <br>
+ * <br />
* Short syntax of:
*
* <pre>
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/InExtensionTag.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/InExtensionTag.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/InExtensionTag.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/InExtensionTag.java Mon Jul 30 23:06:26 2007
@@ -42,7 +42,7 @@
/**
* Renders a text input field with a label.
- * <br>
+ * <br />
* Short syntax of:
*
* <pre>
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TextAreaExtensionTag.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TextAreaExtensionTag.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TextAreaExtensionTag.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TextAreaExtensionTag.java Mon Jul 30 23:06:26 2007
@@ -40,7 +40,7 @@
/**
* Renders a multiline text input control with a label.
- * <br>
+ * <br />
* Short syntax of:
*
* <pre>
Modified: myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TimeExtensionTag.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TimeExtensionTag.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TimeExtensionTag.java (original)
+++ myfaces/tobago/trunk/core/src/main/java/org/apache/myfaces/tobago/taglib/extension/TimeExtensionTag.java Mon Jul 30 23:06:26 2007
@@ -46,7 +46,7 @@
*/
/**
* Renders a time input field with a label.
- * <br>
+ * <br />
* Short syntax of:
*
* <pre>
Modified: myfaces/tobago/trunk/tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/TaglibAnnotationVisitor.java
URL: http://svn.apache.org/viewvc/myfaces/tobago/trunk/tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/TaglibAnnotationVisitor.java?view=diff&rev=561237&r1=561236&r2=561237
==============================================================================
--- myfaces/tobago/trunk/tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/TaglibAnnotationVisitor.java (original)
+++ myfaces/tobago/trunk/tobago-tool/tobago-tool-apt/src/main/java/org/apache/myfaces/tobago/apt/TaglibAnnotationVisitor.java Mon Jul 30 23:06:26 2007
@@ -243,24 +243,23 @@
Deprecated deprecatedAnnotation = decl.getAnnotation(Deprecated.class);
if (deprecatedAnnotation != null) {
- description.append("<p>**** Deprecated. Will be removed in a future version **** </p>");
+ description.append("<p>**** @deprecated. Will be removed in a future version **** </p>");
}
if (deprecated) {
Tag annotationTag = decl.getAnnotation(Tag.class);
- description.append("<p>**** Deprecated. Will be removed in a future version. Use ");
+ description.append("<p>**** @deprecated. Will be removed in a future version. Use ");
description.append(annotationTag.name());
description.append(" instead. **** </p>");
}
Preliminary preliminary = decl.getAnnotation(Preliminary.class);
if (preliminary != null) {
- description.append("</p>**** Preliminary. Maybe subject to changed in a future version");
+ description.append("<p>**** Preliminary. Maybe subject to changed in a future version");
if (preliminary.value().length() > 0) {
description.append(": ");
description.append(preliminary.value());
- description.append(" ");
}
- description.append("**** </p>");
+ description.append(" **** </p>");
}
String comment = decl.getDocComment();
if (comment != null) {
@@ -271,9 +270,9 @@
}
comment = comment.trim();
if (comment.length() > 0) {
- description.append("<p>");
+ //description.append("<p>");
description.append(comment);
- description.append("</p>");
+ //description.append("</p>");
}
}