svn commit: r785040 - /myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java

[lu...@apache.org]

Author: lu4242
Date: Tue Jun 16 00:50:39 2009
New Revision: 785040

URL: http://svn.apache.org/viewvc?rev=785040&view=rev
Log:
fix html tags documentation

Modified:
    myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java

Modified: myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java?rev=785040&r1=785039&r2=785040&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/main/java/org/apache/myfaces/custom/globalId/GlobalId.java Tue Jun 16 00:50:39 2009
@@ -30,12 +30,14 @@
  * Important: this component works only when run in a JSF-1.2 (or later) environment. When run in
  * a JSF-1.1 environment it will not cause an error, but will instead act like a NamingContainer
  * itself, ie will <i>add</i> its own id to the child component's clientId.
+ * </p>
  * <p>
  * Every JSF component has a "clientId" property; when the component is rendered, many components
  * output this as part of the rendered representation. In particular, when rendering HTML, many
  * components write an "id" attribute on their html element which contains the clientId. The clientId
  * is defined as being the clientId value of the nearest NamingContainer ancestor plus ":" plus the
  * component's id.
+ * </p>
  * <p>
  * The prefixing of the parent container's clientId is important for safely building views from
  * multiple files (eg using Facelets templating or JSP includes). However in some cases it is
@@ -43,29 +45,35 @@
  * naming-container prefix; this component can be used to do that simply by adding an instance of
  * this type as an ancestor of the problem components. This works for <i>all</i> JSF components, 
  * not just Tomahawk ones.
+ * </p>
  * <p>
  * Use of this component should be a "last resort"; having clientIds which contain the id of the ancestor
  * NamingContainer is important and useful behaviour. It allows a view to be built from multiple different
  * files (using facelets templating or jsp includes); without this feature, component ids would need to be
  * very carefully managed to ensure the same id was not used in two places. In addition, it would not be
  * possible to include the same page fragment twice.
+ * </p>
  * <p>
  * Ids are sometimes used by Cascading Style Sheets to address individual components, and JSF compound
  * ids are not usable by CSS. However wherever possible use a style <i>class</i> to select the component
  * rather than using this component to assign a "global" id.
+ * </p>
  * <p>
  * Ids are sometimes used by javascript "onclick" handlers to locate HTML elements associated with the
  * clicked item (document.getById). Here, the onclick handler method can be passed the id of the clicked
  * object, and some simple string manipulation can then compute the correct clientId for the target
  * component, rather than using this component to assign a "global" id to the component to be accessed.
+ * </p>
  * <p>
  * This component is similar to the "forceId" attribute available on many Tomahawk components. Unlike
  * the forceId attribute this (a) can be used with all components, not just Tomahawk ones, and (b)
  * applies to all its child components.
+ * </p>
  * <p>
  * Note that since JSF1.2 forms have the property prefixId which can be set to false to make a UIForm
  * act as if it is not a NamingContainer. This is a good idea; the form component should probably
  * never have been a NamingContainer, and disabling this has no significant negative effects.
+ * </p>
  * 
  * @JSFComponent
  *   name = "s:globalId"