This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
commit 3899ca7c12c5516d5ca2e19ef51f3c0825e51dc2
Author: Hervé Boutemy <hbout...@apache.org>
AuthorDate: Wed Dec 13 05:37:35 2017 +0100
improved javadoc
---
.../apache/maven/doxia/siterenderer/DocumentRenderer.java | 13 ++++++-------
.../apache/maven/doxia/siterenderer/SkinResourceLoader.java | 3 ++-
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
index 93fb318..ade6996 100644
---
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
+++
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
@@ -24,19 +24,18 @@ import java.io.UnsupportedEncodingException;
import java.io.Writer;
/**
- * Renders a page, whatever the source is: a Doxia source file, a report or
anything else.
+ * Renders a page in a site, whatever the source is: a Doxia source file, a
report or anything else.
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
- * @version $Id$
*/
public interface DocumentRenderer
{
/**
- * Render a document.
+ * Render a document in a site.
*
- * @param writer the Writer.
- * @param siteRenderer the site Renderer.
- * @param siteRenderingContext the SiteRenderingContext.
+ * @param writer the Writer for the document output.
+ * @param siteRenderer the site renderer to merge document content to.
+ * @param siteRenderingContext the site rendering context.
* @throws org.apache.maven.doxia.siterenderer.RendererException if it
bombs.
* @throws java.io.FileNotFoundException if it bombs.
* @throws java.io.UnsupportedEncodingException if it bombs.
@@ -66,7 +65,7 @@ public interface DocumentRenderer
boolean isOverwrite();
/**
- * Whether this document is an external report.
+ * Whether this document is an external report, independent from the site
templating.
*
* @return {@code true} if report is external, otherwise {@code false}
* @since 1.7
diff --git
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java
index b1bedc4..e8870de 100644
---
a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java
+++
b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SkinResourceLoader.java
@@ -32,7 +32,8 @@ import org.codehaus.plexus.util.IOUtil;
/**
* Skin resource loader: gets content from context classloader, which should
contain skin artifact,
- * and normalizes newlines (see <a
href="https://issues.apache.org/jira/browse/DOXIASITETOOLS-87";>DOXIASITETOOLS-87</a>.
+ * and normalizes newlines
+ * (see <a
href="https://issues.apache.org/jira/browse/DOXIASITETOOLS-87";>DOXIASITETOOLS-87</a>).
*
* @author Hervé Boutemy
*/
--
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <commits@maven.apache.org>.
