Author: jalkanen
Date: Sat Jun 7 04:07:49 2008
New Revision: 664319
URL: http://svn.apache.org/viewvc?rev=664319&view=rev
Log:
Various Javadoc, Java5, checkstyle, and comment fixes.
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CleanTextRenderer.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CreoleRenderer.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/RenderingManager.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WikiRenderer.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WysiwygEditingRenderer.java
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/XHTMLRenderer.java
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CleanTextRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CleanTextRenderer.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CleanTextRenderer.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CleanTextRenderer.java
Sat Jun 7 04:07:49 2008
@@ -46,11 +46,20 @@
protected static final Logger log = Logger.getLogger(
CleanTextRenderer.class );
+ /**
+ * Create a renderer.
+ *
+ * @param context [EMAIL PROTECTED]
+ * @param doc [EMAIL PROTECTED]
+ */
public CleanTextRenderer( WikiContext context, WikiDocument doc )
{
super( context, doc );
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String getString()
throws IOException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CreoleRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CreoleRenderer.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CreoleRenderer.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/CreoleRenderer.java
Sat Jun 7 04:07:49 2008
@@ -79,8 +79,14 @@
private int m_listCount = 0;
private char m_listChar = 'x';
- private List m_plugins = new ArrayList();
+ private List<PluginContent> m_plugins = new ArrayList<PluginContent>();
+ /**
+ * Creates a new Creole Renderer.
+ *
+ * @param ctx [EMAIL PROTECTED]
+ * @param doc [EMAIL PROTECTED]
+ */
public CreoleRenderer( WikiContext ctx, WikiDocument doc )
{
super( ctx, doc );
@@ -186,6 +192,9 @@
sb.append(endEl);
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String getString() throws IOException
{
StringBuffer sb = new StringBuffer(1000);
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/RenderingManager.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/RenderingManager.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/RenderingManager.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/RenderingManager.java
Sat Jun 7 04:07:49 2008
@@ -69,11 +69,16 @@
private WikiEngine m_engine;
+ /**
+ * Parameter value for setting the cache size.
+ */
public static final String PROP_CACHESIZE =
"jspwiki.renderingManager.capacity";
private static final int DEFAULT_CACHESIZE = 1000;
private static final String VERSION_DELIMITER = "::";
private static final String OSCACHE_ALGORITHM =
"com.opensymphony.oscache.base.algorithm.LRUCache";
private static final String PROP_RENDERER =
"jspwiki.renderingManager.renderer";
+
+ /** The name of the default renderer. */
public static final String DEFAULT_RENDERER =
XHTMLRenderer.class.getName();
/**
@@ -86,8 +91,16 @@
*/
private Constructor m_rendererConstructor;
+ /**
+ * Name of the WikiContext variable which is set to Boolean.TRUE or
Boolean.FALSE
+ * depending on whether WYSIWYG is currently in effect.
+ */
public static final String WYSIWYG_EDITOR_MODE = "WYSIWYG_EDITOR_MODE";
+ /**
+ * Variable name which tells whether plugins should be executed or not.
Value
+ * can be either Boolean.TRUE or Boolean.FALSE.
+ */
public static final String VAR_EXECUTE_PLUGINS = "_PluginContent.execute";
/**
@@ -98,9 +111,10 @@
*
* @param engine A WikiEngine instance.
* @param properties A list of properties to get parameters from.
+ * @throws WikiException If the manager could not be initialized.
*/
public void initialize( WikiEngine engine, Properties properties )
- throws WikiException
+ throws WikiException
{
m_engine = engine;
int cacheSize = TextUtil.getIntegerProperty( properties,
PROP_CACHESIZE, -1 );
@@ -175,7 +189,7 @@
* @param context the wiki context
* @param pagedata the page data
* @return the rendered wiki document
- * @throws IOException
+ * @throws IOException If rendering cannot be accomplished
*/
// FIXME: The cache management policy is not very good: deleted/changed
pages
// should be detected better.
@@ -262,6 +276,10 @@
* Returns a WikiRenderer instance, initialized with the given
* context and doc. The object is an XHTMLRenderer, unless overridden
* in jspwiki.properties with PROP_RENDERER.
+ *
+ * @param context The WikiContext
+ * @param doc The document to render
+ * @return A WikiRenderer for this document, or null, if no such renderer
could be instantiated.
*/
public WikiRenderer getRenderer( WikiContext context, WikiDocument doc )
{
@@ -310,8 +328,9 @@
* Flushes the document cache in response to a POST_SAVE_BEGIN event.
*
* @see
com.ecyrd.jspwiki.event.WikiEventListener#actionPerformed(com.ecyrd.jspwiki.event.WikiEvent)
+ * @param event [EMAIL PROTECTED]
*/
- // @SuppressWarnings("deprecation")
+ @SuppressWarnings("deprecation")
public void actionPerformed(WikiEvent event)
{
if( (event instanceof WikiPageEvent) && (event.getType() ==
WikiPageEvent.POST_SAVE_BEGIN) )
Modified: incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WikiRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WikiRenderer.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WikiRenderer.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WikiRenderer.java Sat
Jun 7 04:07:49 2008
@@ -43,6 +43,12 @@
protected WikiDocument m_document;
protected boolean m_enablePlugins = true;
+ /**
+ * Create a WikiRenderer.
+ *
+ * @param context A WikiContext in which the rendering will take place.
+ * @param doc The WikiDocument which shall be rendered.
+ */
protected WikiRenderer( WikiContext context, WikiDocument doc )
{
m_context = context;
@@ -58,13 +64,21 @@
}
/**
- * Can be used to turn on plugin execution on a translator-reader basis
+ * Can be used to turn on plugin execution on a translator-reader basis.
+ *
+ * @param toggle True, if plugins are to be enabled. False, if disabled.
*/
public void enablePlugins( boolean toggle )
{
m_enablePlugins = toggle;
}
+ /**
+ * Renders and returns the end result.
+ *
+ * @return A rendered string.
+ * @throws IOException If rendering fails.
+ */
public abstract String getString()
throws IOException;
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WysiwygEditingRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WysiwygEditingRenderer.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
---
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WysiwygEditingRenderer.java
(original)
+++
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/WysiwygEditingRenderer.java
Sat Jun 7 04:07:49 2008
@@ -55,6 +55,12 @@
private static final String LINKS_TRANSLATION = "$1#$2";
private static final String LINKS_SOURCE = "(.+)#section-.+-(.+)";
+ /**
+ * Creates a WYSIWYG editing renderer.
+ *
+ * @param context [EMAIL PROTECTED]
+ * @param doc [EMAIL PROTECTED]
+ */
public WysiwygEditingRenderer( WikiContext context, WikiDocument doc )
{
super( context, doc );
@@ -105,8 +111,8 @@
// to this wiki string: "TargetPage#Heading2".
hrefAttr.setValue( newHref.replaceFirst(
LINKS_SOURCE, LINKS_TRANSLATION ) );
}
- else if ( classValue.equals( EDITPAGE )
- || ( hrefAttr != null &&
hrefAttr.getValue().startsWith( editPageLinkUrl ) ) )
+ else if( hrefAttr != null && (classValue.equals(
EDITPAGE ) ||
+
hrefAttr.getValue().startsWith( editPageLinkUrl ) ) )
{
Attribute titleAttr = element.getAttribute(
TITLE_ATTRIBUTE );
if( titleAttr != null )
@@ -136,6 +142,9 @@
}
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String getString()
throws IOException
{
Modified:
incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/XHTMLRenderer.java
URL:
http://svn.apache.org/viewvc/incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/XHTMLRenderer.java?rev=664319&r1=664318&r2=664319&view=diff
==============================================================================
--- incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/XHTMLRenderer.java
(original)
+++ incubator/jspwiki/trunk/src/com/ecyrd/jspwiki/render/XHTMLRenderer.java Sat
Jun 7 04:07:49 2008
@@ -41,11 +41,20 @@
{
private static final String LINEBREAK = "\n";
+ /**
+ * Creates an XHTML 1.0 renderer.
+ *
+ * @param context [EMAIL PROTECTED]
+ * @param doc [EMAIL PROTECTED]
+ */
public XHTMLRenderer( WikiContext context, WikiDocument doc )
{
super( context, doc );
}
+ /**
+ * [EMAIL PROTECTED]
+ */
public String getString()
throws IOException
{
