Improved documentation for <badge>

annina92 · Apr 17, 2014 · 68a2937 · 68a2937
1 parent c6555e2
commit 68a2937
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/src/org/bootstrapjsp/tags/core/misc/Badge.java b/src/org/bootstrapjsp/tags/core/misc/Badge.java
@@ -12,7 +12,16 @@
 import org.tldgen.annotations.Tag;
 
 /**
- * A badge.
+ * Easily highlight new or unread items by adding a <i>&lt;badge&gt;</i> to 
+ * links, Bootstrap navs, and more.
+ * <p>
+ * <dl>
+ * <dt><b>Example</b></dt>
+ * <dd>&lt;b:badge align="right"&gt;... &lt;/b:badge&gt;</dd>
+ * <dt><b>Output</b></dt>
+ * <dd>&lt;span class="badge pull-right"&gt;... &lt;/span&gt;</dd>
+ * </dl>
+ * </p>
  */
 @Tag(bodyContent=BodyContent.SCRIPTLESS, dynamicAttributes=true)
 public class Badge extends Span {