Author: jalkanen
Date: Wed May 7 13:42:02 2008
New Revision: 654268
URL: http://svn.apache.org/viewvc?rev=654268&view=rev
Log:
Fixed javadocs & Checkstyle warnings
Removed:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSCoffeeCupLinkTag.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ParentPageNameTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PermissionTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PluginTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PreviousVersionTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSImageLinkTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSLinkTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RequestResourceTag.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/TabbedSectionTag.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ParentPageNameTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ParentPageNameTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ParentPageNameTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/ParentPageNameTag.java
Wed May 7 13:42:02 2008
@@ -37,6 +37,10 @@
{
private static final long serialVersionUID = 0L;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public final int doWikiStartTag()
throws IOException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PermissionTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PermissionTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PermissionTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PermissionTag.java Wed
May 7 13:42:02 2008
@@ -85,6 +85,7 @@
/**
* Initializes the tag.
*/
+ @Override
public void initTag()
{
super.initTag();
@@ -175,6 +176,7 @@
* @return the result of the tag: SKIP_BODY or EVAL_BODY_CONTINUE
* @throws IOException this exception will never be thrown
*/
+ @Override
public final int doWikiStartTag()
throws IOException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PluginTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PluginTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PluginTag.java (original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PluginTag.java Wed May
7 13:42:02 2008
@@ -51,6 +51,10 @@
private boolean m_evaluated = false;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public void release()
{
super.release();
@@ -58,16 +62,30 @@
m_evaluated = false;
}
+ /**
+ * Set the name of the plugin to execute.
+ *
+ * @param p Name of the plugin.
+ */
public void setPlugin( String p )
{
m_plugin = p;
}
+ /**
+ * Set the argument string to the plugin.
+ *
+ * @param a Arguments string.
+ */
public void setArgs( String a )
{
m_args = a;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doWikiStartTag() throws JspException, IOException
{
m_evaluated = false;
@@ -94,6 +112,10 @@
return result;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doEndTag()
throws JspException
{
@@ -112,6 +134,10 @@
return EVAL_PAGE;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doAfterBody()
throws JspException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PreviousVersionTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PreviousVersionTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PreviousVersionTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/PreviousVersionTag.java
Wed May 7 13:42:02 2008
@@ -34,6 +34,10 @@
{
private static final long serialVersionUID = 0L;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public final int doWikiStartTag()
throws IOException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSImageLinkTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSImageLinkTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSImageLinkTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSImageLinkTag.java Wed
May 7 13:42:02 2008
@@ -27,7 +27,8 @@
import com.ecyrd.jspwiki.WikiEngine;
/**
- * Writes an image link to the RSS file.
+ * Writes an image link to the global JSPWiki RSS file. If RSS generation has
+ * been turned off in jspwiki.properties, returns an empty string.
*
* @since 2.0
*/
@@ -38,22 +39,40 @@
protected String m_title;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public void initTag()
{
super.initTag();
m_title = null;
}
+ /**
+ * Sets the title for the link. If not defined, no title is shown.
+ *
+ * @param title A string for the title.
+ */
public void setTitle( String title )
{
m_title = title;
}
+ /**
+ * Returns the title.
+ *
+ * @return The title.
+ */
public String getTitle()
{
return m_title;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public final int doWikiStartTag()
throws IOException
{
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSLinkTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSLinkTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSLinkTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RSSLinkTag.java Wed May
7 13:42:02 2008
@@ -38,6 +38,10 @@
{
private static final long serialVersionUID = 0L;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public final int doWikiStartTag()
throws IOException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RequestResourceTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RequestResourceTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RequestResourceTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/RequestResourceTag.java
Wed May 7 13:42:02 2008
@@ -26,6 +26,7 @@
* Provides easy access to TemplateManager.addResourceRequest(). You may use
* any of the request types defined there.
*
+ * @see TemplateManager
*/
public class RequestResourceTag extends WikiTagBase
{
@@ -34,12 +35,20 @@
private String m_type;
private String m_resource;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public void initTag()
{
super.initTag();
m_type = m_resource = null;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doWikiStartTag() throws Exception
{
if( m_type != null && m_resource != null )
@@ -50,20 +59,45 @@
return SKIP_BODY;
}
+ /**
+ * Returns the resource that is to be added.
+ *
+ * @return The resource name.
+ */
public String getResource()
{
return m_resource;
}
+ /**
+ * Sets the resource name to be added.
+ *
+ * @param r Resource identifier.
+ */
public void setResource(String r)
{
m_resource = r;
}
+ /**
+ * Get the resource type.
+ *
+ * @return The type of the resource.
+ */
public String getType()
{
return m_type;
}
+
+ /**
+ * Set the type of the resource to be included. For example, "script".
Please
+ * see the TemplateManager class for more information about the different
kinds
+ * of types you can use.
+ *
+ * @see TemplateManager
+ *
+ * @param type The type to be set.
+ */
public void setType(String type)
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/TabbedSectionTag.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/TabbedSectionTag.java?rev=654268&r1=654267&r2=654268&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/TabbedSectionTag.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/tags/TabbedSectionTag.java
Wed May 7 13:42:02 2008
@@ -35,7 +35,7 @@
* @author Dirk Frederickx
* @since v2.3.63
*/
-
+// FIXME: Needs a bit more of explaining how this tag works.
public class TabbedSectionTag extends BodyTagSupport
{
private static final long serialVersionUID = 1702437933960026481L;
@@ -53,6 +53,10 @@
private int m_state = FIND_DEFAULT_TAB;
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public void release()
{
super.release();
@@ -62,11 +66,19 @@
m_state = FIND_DEFAULT_TAB;
}
+ /**
+ * Set the id of the default tab (the tab which should be shown when
+ * the page is first loaded).
+ *
+ * @param anDefaultTabId ID attribute of the default tab.
+ */
public void setDefaultTab(String anDefaultTabId)
{
m_defaultTabId = anDefaultTabId;
}
+ // FIXME: I don't really understand what this does - so Dirk, please
+ // add some documentation.
public boolean validateDefaultTab( String aTabId )
{
if( m_firstTabId == null ) m_firstTabId = aTabId;
@@ -75,32 +87,59 @@
return aTabId.equals( m_defaultTabId );
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doStartTag() throws JspTagException
{
return EVAL_BODY_BUFFERED; /* always look inside */
}
+ /**
+ * Returns true, if the tab system is currently trying to
+ * figure out which is the default tab.
+ *
+ * @return True, if finding the default tab.
+ */
public boolean isStateFindDefaultTab()
{
return m_state == FIND_DEFAULT_TAB;
}
+ /**
+ * Returns true, if the tab system is currently generating
+ * the tab menu.
+ *
+ * @return True, if currently generating the menu itself.
+ */
public boolean isStateGenerateTabMenu()
{
return m_state == GENERATE_TABMENU;
}
+ /**
+ * Returns true, if the tab system is currently generating
+ * the tab body.
+ *
+ * @return True, if the tab system is currently generating the tab body.
+ */
public boolean isStateGenerateTabBody()
{
return m_state == GENERATE_TABBODY;
}
- /* The tabbed section iterates 3 time through the underlying Tab tags
+ /**
+ * The tabbed section iterates 3 time through the underlying Tab tags
* - first it identifies the default tab (displayed by default)
* - second it generates the tabmenu markup (displays all tab-titles)
* - finally it generates the content of each tab.
+ *
+ * @return [EMAIL PROTECTED]
+ * @throws [EMAIL PROTECTED]
*/
+ @Override
public int doAfterBody() throws JspTagException
{
if( isStateFindDefaultTab() )
@@ -138,6 +177,10 @@
return SKIP_BODY;
}
+ /**
+ * [EMAIL PROTECTED]
+ */
+ @Override
public int doEndTag() throws JspTagException
{
try
