You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2014/04/20 10:13:15 UTC
svn commit: r1588724 - in
/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer:
./ sink/
Author: hboutemy
Date: Sun Apr 20 08:13:14 2014
New Revision: 1588724
URL: http://svn.apache.org/r1588724
Log:
improved javadoc
Modified:
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/RenderingContext.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/SkinResourceLoader.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/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=1588724&r1=1588723&r2=1588724&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 Sun Apr 20 08:13:14 2014
@@ -52,7 +52,7 @@ public interface DocumentRenderer
String getOutputName();
/**
- * Return the RenderingContext.
+ * Return the RenderingContext of the document.
*
* @return RenderingContext.
*/
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=1588724&r1=1588723&r2=1588724&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 Sun Apr 20 08:13:14 2014
@@ -37,7 +37,7 @@ public class DoxiaDocumentRenderer
/**
* Constructor.
*
- * @param renderingContext the RenderingContext to use.
+ * @param renderingContext the document's RenderingContext to use.
*/
public DoxiaDocumentRenderer( RenderingContext renderingContext )
{
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=1588724&r1=1588723&r2=1588724&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 Sun Apr 20 08:13:14 2014
@@ -22,7 +22,7 @@ package org.apache.maven.doxia.siterende
import java.io.File;
/**
- * Holds a small extra module reference in the list of added modules to the rendering context.
+ * Holds an extra Doxia source module reference in the list of added modules to the site rendering context.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
@@ -41,7 +41,7 @@ class ModuleReference
/**
* <p>Getter for the field <code>parserId</code>.</p>
*
- * @return a {@link java.lang.String} object.
+ * @return Doxia parser id associated to this source module.
*/
public String getParserId()
{
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java?rev=1588724&r1=1588723&r2=1588724&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java Sun Apr 20 08:13:14 2014
@@ -77,10 +77,10 @@ public class RenderingContext
/**
* <p>Constructor for RenderingContext.</p>
*
- * @param basedir a {@link java.io.File} object.
- * @param document a {@link java.lang.String} object.
- * @param parserId a {@link java.lang.String} object.
- * @param extension a {@link java.lang.String} object.
+ * @param basedir the source base directory.
+ * @param document the source document name.
+ * @param parserId the Doxia module parser id associated to this document.
+ * @param extension the source document filename extension.
*/
public RenderingContext( File basedir, String document, String parserId, String extension )
{
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=1588724&r1=1588723&r2=1588724&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 Sun Apr 20 08:13:14 2014
@@ -289,7 +289,7 @@ public class SiteRenderingContext
* Add a module source directory.
*
* @param moduleBasedir The base directory for module's source files.
- * @param moduleParserId a {@link java.lang.String} object.
+ * @param moduleParserId module's Doxia parser id.
*/
public void addModuleDirectory( File moduleBasedir, String moduleParserId )
{
Modified: maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java?rev=1588724&r1=1588723&r2=1588724&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java Sun Apr 20 08:13:14 2014
@@ -32,7 +32,9 @@ import org.codehaus.plexus.util.IOUtil;
/**
* Skin resource loader: gets content from context classloader, which should contain skin artifact,
- * and normalizes newlines.
+ * and normalizes newlines (see <a href="http://jira.codehaus.org/browse/DOXIASITETOOLS-87">DOXIASITETOOLS-87</a>.
+ *
+ * @author Hervé Boutemy
*/
public class SkinResourceLoader
extends ResourceLoader
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=1588724&r1=1588723&r2=1588724&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 Sun Apr 20 08:13:14 2014
@@ -36,7 +36,7 @@ import org.apache.maven.doxia.util.HtmlT
import org.codehaus.plexus.util.StringUtils;
/**
- * Sink for site rendering.
+ * Sink for site rendering of a document, to allow later merge document's output with a template.
*
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
* @version $Id$
@@ -66,9 +66,9 @@ public class SiteRendererSink
private RenderingContext renderingContext;
/**
- * Construct a new SiteRendererSink.
+ * Construct a new SiteRendererSink for a document.
*
- * @param renderingContext the RenderingContext.
+ * @param renderingContext the document's RenderingContext.
*/
public SiteRendererSink( RenderingContext renderingContext )
{
@@ -76,10 +76,10 @@ public class SiteRendererSink
}
/**
- * Construct a new SiteRendererSink.
+ * Construct a new SiteRendererSink for a document.
*
* @param writer the writer for the sink.
- * @param renderingContext the RenderingContext.
+ * @param renderingContext the document's RenderingContext.
*/
private SiteRendererSink( StringWriter writer, RenderingContext renderingContext )
{