Author: vsiveton
Date: Mon Feb 23 12:56:04 2009
New Revision: 746999
URL: http://svn.apache.org/viewvc?rev=746999&view=rev
Log:
o fix javadoc using javadoc:fix
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
Mon Feb 23 12:56:04 2009
@@ -82,6 +82,8 @@
/**
+ * <p>DefaultSiteRenderer class.</p>
+ *
* @author <a href="mailto:eveni...@codehaus.org";>Emmanuel Venisse</a>
* @author <a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a>
* @version $Id$
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
Mon Feb 23 12:56:04 2009
@@ -29,6 +29,7 @@
* Renders a page.
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
+ * @version $Id$
*/
public interface DocumentRenderer
{
@@ -54,12 +55,14 @@
/**
* Return the RenderingContext.
+ *
* @return RenderingContext.
*/
RenderingContext getRenderingContext();
/**
* Whether to always overwrite the document, or only do so when it is
changed.
+ *
* @return whether to overwrite
*/
boolean isOverwrite();
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
Mon Feb 23 12:56:04 2009
@@ -29,6 +29,7 @@
* Renders a page with Doxia.
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
+ * @version $Id$
*/
public class DoxiaDocumentRenderer
implements DocumentRenderer
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
Mon Feb 23 12:56:04 2009
@@ -38,11 +38,21 @@
this.basedir = basedir;
}
+ /**
+ * <p>Getter for the field <code>parserId</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getParserId()
{
return parserId;
}
+ /**
+ * <p>Getter for the field <code>basedir</code>.</p>
+ *
+ * @return a {...@link java.io.File} object.
+ */
public File getBasedir()
{
return basedir;
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
Mon Feb 23 12:56:04 2009
@@ -34,6 +34,8 @@
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
/**
+ * <p>Renderer interface.</p>
+ *
* @author <a href="mailto:eveni...@codehaus.org";>Emmanuel Venisse</a>
* @version $Id$
*/
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RendererException.java
Mon Feb 23 12:56:04 2009
@@ -20,7 +20,10 @@
*/
/**
+ * <p>RendererException class.</p>
+ *
* @author Emmanuel Venisse
+ * @version $Id$
*/
public class RendererException
extends Exception
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java
Mon Feb 23 12:56:04 2009
@@ -29,6 +29,8 @@
import org.apache.maven.doxia.site.decoration.DecorationModel;
/**
+ * <p>SiteRenderingContext class.</p>
+ *
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
* @version $Id$
*/
@@ -64,131 +66,262 @@
private List modules = new ArrayList();
+ /**
+ * <p>Getter for the field <code>templateName</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getTemplateName()
{
return templateName;
}
+ /**
+ * <p>Getter for the field <code>templateClassLoader</code>.</p>
+ *
+ * @return a {...@link java.lang.ClassLoader} object.
+ */
public ClassLoader getTemplateClassLoader()
{
return templateClassLoader;
}
+ /**
+ * <p>Setter for the field <code>templateClassLoader</code>.</p>
+ *
+ * @param templateClassLoader a {...@link java.lang.ClassLoader} object.
+ */
public void setTemplateClassLoader( ClassLoader templateClassLoader )
{
this.templateClassLoader = templateClassLoader;
}
+ /**
+ * <p>Getter for the field <code>templateProperties</code>.</p>
+ *
+ * @return a {...@link java.util.Map} object.
+ */
public Map getTemplateProperties()
{
return templateProperties;
}
+ /**
+ * <p>Setter for the field <code>templateProperties</code>.</p>
+ *
+ * @param templateProperties a {...@link java.util.Map} object.
+ */
public void setTemplateProperties( Map templateProperties )
{
this.templateProperties = Collections.unmodifiableMap(
templateProperties );
}
+ /**
+ * <p>Getter for the field <code>locale</code>.</p>
+ *
+ * @return a {...@link java.util.Locale} object.
+ */
public Locale getLocale()
{
return locale;
}
+ /**
+ * <p>Setter for the field <code>locale</code>.</p>
+ *
+ * @param locale a {...@link java.util.Locale} object.
+ */
public void setLocale( Locale locale )
{
this.locale = locale;
}
+ /**
+ * <p>Getter for the field <code>decoration</code>.</p>
+ *
+ * @return a {...@link
org.apache.maven.doxia.site.decoration.DecorationModel} object.
+ */
public DecorationModel getDecoration()
{
return decoration;
}
+ /**
+ * <p>Setter for the field <code>decoration</code>.</p>
+ *
+ * @param decoration a {...@link
org.apache.maven.doxia.site.decoration.DecorationModel} object.
+ */
public void setDecoration( DecorationModel decoration )
{
this.decoration = decoration;
}
+ /**
+ * <p>Setter for the field <code>defaultWindowTitle</code>.</p>
+ *
+ * @param defaultWindowTitle a {...@link java.lang.String} object.
+ */
public void setDefaultWindowTitle( String defaultWindowTitle )
{
this.defaultWindowTitle = defaultWindowTitle;
}
+ /**
+ * <p>Getter for the field <code>defaultWindowTitle</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getDefaultWindowTitle()
{
return defaultWindowTitle;
}
+ /**
+ * <p>Getter for the field <code>skinJarFile</code>.</p>
+ *
+ * @return a {...@link java.io.File} object.
+ */
public File getSkinJarFile()
{
return skinJarFile;
}
+ /**
+ * <p>Setter for the field <code>skinJarFile</code>.</p>
+ *
+ * @param skinJarFile a {...@link java.io.File} object.
+ */
public void setSkinJarFile( File skinJarFile )
{
this.skinJarFile = skinJarFile;
}
+ /**
+ * <p>Setter for the field <code>templateName</code>.</p>
+ *
+ * @param templateName a {...@link java.lang.String} object.
+ */
public void setTemplateName( String templateName )
{
this.templateName = templateName;
}
+ /**
+ * <p>Setter for the field <code>usingDefaultTemplate</code>.</p>
+ *
+ * @param usingDefaultTemplate a boolean.
+ */
public void setUsingDefaultTemplate( boolean usingDefaultTemplate )
{
this.usingDefaultTemplate = usingDefaultTemplate;
}
+ /**
+ * <p>isUsingDefaultTemplate</p>
+ *
+ * @return a boolean.
+ */
public boolean isUsingDefaultTemplate()
{
return usingDefaultTemplate;
}
+ /**
+ * <p>addSiteDirectory</p>
+ *
+ * @param file a {...@link java.io.File} object.
+ */
public void addSiteDirectory( File file )
{
this.siteDirectories.add( file );
}
+ /**
+ * <p>addModuleDirectory</p>
+ *
+ * @param file a {...@link java.io.File} object.
+ * @param moduleParserId a {...@link java.lang.String} object.
+ */
public void addModuleDirectory( File file, String moduleParserId )
{
this.modules.add( new ModuleReference( moduleParserId, file ) );
}
+ /**
+ * <p>Getter for the field <code>siteDirectories</code>.</p>
+ *
+ * @return a {...@link java.util.List} object.
+ */
public List getSiteDirectories()
{
return siteDirectories;
}
+ /**
+ * <p>Getter for the field <code>modules</code>.</p>
+ *
+ * @return a {...@link java.util.List} object.
+ */
public List getModules()
{
return modules;
}
+ /**
+ * <p>Getter for the field <code>moduleExcludes</code>.</p>
+ *
+ * @return a {...@link java.util.Map} object.
+ */
public Map getModuleExcludes()
{
return moduleExcludes;
}
+ /**
+ * <p>Setter for the field <code>moduleExcludes</code>.</p>
+ *
+ * @param moduleExcludes a {...@link java.util.Map} object.
+ */
public void setModuleExcludes( Map moduleExcludes )
{
this.moduleExcludes = moduleExcludes;
}
+ /**
+ * <p>Getter for the field <code>inputEncoding</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getInputEncoding()
{
return inputEncoding;
}
+ /**
+ * <p>Setter for the field <code>inputEncoding</code>.</p>
+ *
+ * @param inputEncoding a {...@link java.lang.String} object.
+ */
public void setInputEncoding( String inputEncoding )
{
this.inputEncoding = inputEncoding;
}
+ /**
+ * <p>Getter for the field <code>outputEncoding</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getOutputEncoding()
{
return outputEncoding;
}
+ /**
+ * <p>Setter for the field <code>outputEncoding</code>.</p>
+ *
+ * @param outputEncoding a {...@link java.lang.String} object.
+ */
public void setOutputEncoding( String outputEncoding )
{
this.outputEncoding = outputEncoding;
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java?rev=746999&r1=746998&r2=746999&view=diff
==============================================================================
---
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
(original)
+++
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
Mon Feb 23 12:56:04 2009
@@ -92,8 +92,9 @@
}
/**
- * Do nothing.
+ * {...@inheritdoc}
*
+ * Do nothing.
* @see org.apache.maven.doxia.module.xhtml.XhtmlSink#title()
*/
public void title()
@@ -101,6 +102,11 @@
// nop
}
+ /**
+ * <p>Getter for the field <code>title</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getTitle()
{
return title;
@@ -117,6 +123,11 @@
resetTextBuffer();
}
+ /**
+ * <p>Getter for the field <code>authors</code>.</p>
+ *
+ * @return a {...@link java.util.List} object.
+ */
public List getAuthors()
{
return authors;
@@ -133,14 +144,20 @@
resetTextBuffer();
}
+ /**
+ * <p>Getter for the field <code>date</code>.</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getDate()
{
return date;
}
/**
- * Do nothing.
+ * {...@inheritdoc}
*
+ * Do nothing.
* @see org.apache.maven.doxia.module.xhtml.XhtmlSink#body_()
*/
public void body_()
@@ -149,8 +166,9 @@
}
/**
- * Do nothing.
+ * {...@inheritdoc}
*
+ * Do nothing.
* @see org.apache.maven.doxia.module.xhtml.XhtmlSink#body()
*/
public void body()
@@ -158,6 +176,11 @@
// nop
}
+ /**
+ * <p>getBody</p>
+ *
+ * @return a {...@link java.lang.String} object.
+ */
public String getBody()
{
return writer.toString();
@@ -229,8 +252,9 @@
}
/**
- * Sets the head flag to true so the title text is buffered until the
closing tag.
+ * {...@inheritdoc}
*
+ * Sets the head flag to true so the title text is buffered until the
closing tag.
* @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle1()
*/
public void sectionTitle1()
@@ -239,9 +263,10 @@
}
/**
+ * {...@inheritdoc}
+ *
* Writes out a sectionTitle1 block, including an anchor that is
constructed from the
* buffered title text via {...@link
org.apache.maven.doxia.util.HtmlTools#encodeId(String)}.
- *
* @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle1_()
*/
public void sectionTitle1_()
@@ -250,8 +275,9 @@
}
/**
- * Sets the head flag to true so the title text is buffered until the
closing tag.
+ * {...@inheritdoc}
*
+ * Sets the head flag to true so the title text is buffered until the
closing tag.
* @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle2()
*/
public void sectionTitle2()
@@ -260,9 +286,10 @@
}
/**
+ * {...@inheritdoc}
+ *
* Writes out a sectionTitle2 block, including an anchor that is
constructed from the
* buffered title text via {...@link
org.apache.maven.doxia.util.HtmlTools#encodeId(String)}.
- *
* @see org.apache.maven.doxia.sink.XhtmlBaseSink#sectionTitle2_()
*/
public void sectionTitle2_()
@@ -271,7 +298,10 @@
}
/**
+ * <p>Getter for the field <code>renderingContext</code>.</p>
+ *
* @return the current rendering context
+ * @since 1.1
*/
public RenderingContext getRenderingContext()
{
