svn commit: r654258 - /incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java

[jalkanen]

Author: jalkanen
Date: Wed May  7 13:20:08 2008
New Revision: 654258

URL: http://svn.apache.org/viewvc?rev=654258&view=rev
Log:
Fixed javadocs & Checkstyle warnings

Modified:
    incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java

Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java
URL: 
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java?rev=654258&r1=654257&r2=654258&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java 
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/UserCheckTag.java Wed 
May  7 13:20:08 2008
@@ -83,20 +83,34 @@
 
     private String m_status;
 
+    /**
+     *  [EMAIL PROTECTED]
+     */
+    @Override
     public void initTag()
     {
         super.initTag();
         m_status = null;
     }
 
+    /**
+     *  Get the status as defined above.
+     *  
+     *  @return The status to be checked.
+     */
     public String getStatus()
     {
-        return( m_status );
+        return m_status;
     }
 
-    public void setStatus( String arg )
+    /**
+     *  Sets the status as defined above.
+     *  
+     *  @param status The status to be checked.
+     */
+    public void setStatus( String status )
     {
-        m_status = arg.toLowerCase();
+        m_status = status.toLowerCase();
     }
 
 
@@ -104,6 +118,8 @@
      *  Sets the "exists" attribute, which is converted on-the-fly into
      *  an equivalent "status" -attribute.  This is only for backwards 
compatibility.
      *
+     *  @param arg If true, works exactly as status = authenticated.  If 
false, works
+     *             as if status = anonymous.
      *  @deprecated
      */
     public void setExists( String arg )
@@ -120,8 +136,10 @@
 
 
     /**
+     * [EMAIL PROTECTED]
      * @see com.ecyrd.jspwiki.tags.WikiTagBase#doWikiStartTag()
      */
+    @Override
     public final int doWikiStartTag()
         throws IOException
     {