svn commit: r646040 - /incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java

[ja...@apache.org]

Author: jalkanen
Date: Tue Apr  8 12:19:24 2008
New Revision: 646040

URL: http://svn.apache.org/viewvc?rev=646040&view=rev
Log:
Added javadocs.

Modified:
    incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java

Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java?rev=646040&r1=646039&r2=646040&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/parser/Heading.java Tue Apr  8 12:19:24 2008
@@ -28,12 +28,38 @@
  */
 public class Heading
 {
+    /**
+     *  Defines a small heading.
+     */
     public static final int HEADING_SMALL  = 1;
+    
+    /**
+     *  Defines a medium-size heading.
+     */
     public static final int HEADING_MEDIUM = 2;
+    
+    /**
+     *  Defines a large heading.
+     */
     public static final int HEADING_LARGE  = 3;
 
+    /**
+     *  Denotes the level of the heading. Either HEADING_SMALL, HEADING_MEDIUM, or HEADING_LARGE.
+     */
     public int    m_level;
+    
+    /**
+     *  Contains the text of the heading.
+     */
     public String m_titleText;
+    
+    /**
+     *  Contains the anchor to the heading
+     */
     public String m_titleAnchor;
+    
+    /**
+     *  Contains a section link.
+     */
     public String m_titleSection;
 }