Author: hboutemy
Date: Sat Dec 19 13:44:56 2015
New Revision: 1720924
URL: http://svn.apache.org/viewvc?rev=1720924&view=rev
Log:
reworked javadoc and internals
Added:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ExtraDoxiaModuleReference.java
- copied, changed from r1720901,
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
Removed:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java
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/Renderer.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
maven/doxia/doxia-sitetools/trunk/pom.xml
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -131,42 +131,34 @@ public class DefaultSiteRenderer
Map<String, DocumentRenderer> files = new LinkedHashMap<String,
DocumentRenderer>();
Map<String, String> moduleExcludes =
siteRenderingContext.getModuleExcludes();
+ // look in every site directory (in general src/site or
target/generated-site)
for ( File siteDirectory : siteRenderingContext.getSiteDirectories() )
{
if ( siteDirectory.exists() )
{
Collection<ParserModule> modules =
parserModuleManager.getParserModules();
+ // use every Doxia parser module
for ( ParserModule module : modules )
{
File moduleBasedir = new File( siteDirectory,
module.getSourceDirectory() );
- if ( moduleExcludes != null && moduleExcludes.containsKey(
module.getParserId() ) )
- {
- addModuleFiles( moduleBasedir, module,
moduleExcludes.get( module.getParserId() ),
- files );
- }
- else
- {
- addModuleFiles( moduleBasedir, module, null, files );
- }
+ String excludes = ( moduleExcludes == null ) ? null :
moduleExcludes.get( module.getParserId() );
+
+ addModuleFiles( moduleBasedir, module, excludes, files );
}
}
}
- for ( ModuleReference module : siteRenderingContext.getModules() )
+ // look in specific modules directories (used for old Maven 1.x site
layout: xdoc and fml docs in /xdocs)
+ for ( ExtraDoxiaModuleReference module :
siteRenderingContext.getModules() )
{
try
{
- if ( moduleExcludes != null && moduleExcludes.containsKey(
module.getParserId() ) )
- {
- addModuleFiles( module.getBasedir(),
parserModuleManager.getParserModule( module.getParserId() ),
- moduleExcludes.get( module.getParserId() ), files );
- }
- else
- {
- addModuleFiles( module.getBasedir(),
parserModuleManager.getParserModule( module.getParserId() ),
- null, files );
- }
+ ParserModule parserModule =
parserModuleManager.getParserModule( module.getParserId() );
+
+ String excludes = ( moduleExcludes == null ) ? null :
moduleExcludes.get( module.getParserId() );
+
+ addModuleFiles( module.getBasedir(), parserModule, excludes,
files );
}
catch ( ParserModuleNotFoundException e )
{
@@ -176,100 +168,95 @@ public class DefaultSiteRenderer
return files;
}
+ private List<String> filterExtensionIgnoreCase( List<String> fileNames,
String extension )
+ {
+ List<String> filtered = new LinkedList<String>( fileNames );
+ for ( Iterator<String> it = filtered.iterator(); it.hasNext(); )
+ {
+ String name = it.next();
+
+ // Take care of extension case
+ if ( !endsWithIgnoreCase( name, extension ) )
+ {
+ it.remove();
+ }
+ }
+ return filtered;
+ }
+
private void addModuleFiles( File moduleBasedir, ParserModule module,
String excludes,
Map<String, DocumentRenderer> files )
throws IOException, RendererException
{
- if ( moduleBasedir.exists() )
+ if ( !moduleBasedir.exists() || ArrayUtils.isEmpty(
module.getExtensions() ) )
{
- List<String> allFiles = FileUtils.getFileNames( moduleBasedir,
"**/*.*", excludes, false );
- if ( !ArrayUtils.isEmpty( module.getExtensions() ) )
- {
- for ( String extension : module.getExtensions() )
- {
+ return;
+ }
- String fullExtension = "." + extension;
- List<String> docs = new LinkedList<String>( allFiles );
- // Take care of extension case
- for ( Iterator<String> it = docs.iterator(); it.hasNext();
)
- {
- String name = it.next();
+ List<String> allFiles = FileUtils.getFileNames( moduleBasedir,
"**/*.*", excludes, false );
- if ( !endsWithIgnoreCase( name, fullExtension ) )
- {
- it.remove();
- }
- }
+ for ( String extension : module.getExtensions() )
+ {
+ String fullExtension = "." + extension;
- List<String> velocityFiles = new LinkedList<String>(
allFiles );
- // *.xml.vm
- fullExtension += ".vm";
- for ( Iterator<String> it = velocityFiles.iterator();
it.hasNext(); )
- {
- String name = it.next();
+ List<String> docs = filterExtensionIgnoreCase( allFiles,
fullExtension );
- if ( !endsWithIgnoreCase( name, fullExtension ) )
- {
- it.remove();
- }
- }
- docs.addAll( velocityFiles );
+ // *.<extension>.vm
+ List<String> velocityFiles = filterExtensionIgnoreCase( allFiles,
fullExtension + ".vm" );
- for ( String doc : docs )
- {
- RenderingContext context =
- new RenderingContext( moduleBasedir, doc,
module.getParserId(), extension );
+ docs.addAll( velocityFiles );
- // TODO: DOXIA-111: we need a general filter here that
knows how to alter the context
- if ( doc.substring( doc.length() - 3
).equalsIgnoreCase( ".vm" ) )
- {
- context.setAttribute( "velocity", "true" );
- }
+ for ( String doc : docs )
+ {
+ RenderingContext context =
+ new RenderingContext( moduleBasedir, doc,
module.getParserId(), extension );
- String key = context.getOutputName();
- key = StringUtils.replace( key, "\\", "/" );
+ // TODO: DOXIA-111: we need a general filter here that knows
how to alter the context
+ if ( endsWithIgnoreCase( doc, ".vm" ) )
+ {
+ context.setAttribute( "velocity", "true" );
+ }
- if ( files.containsKey( key ) )
- {
- DocumentRenderer renderer = files.get( key );
+ String key = context.getOutputName();
+ key = StringUtils.replace( key, "\\", "/" );
- RenderingContext originalContext =
renderer.getRenderingContext();
+ if ( files.containsKey( key ) )
+ {
+ DocumentRenderer renderer = files.get( key );
- File originalDoc = new File(
originalContext.getBasedir(), originalContext.getInputName() );
+ RenderingContext originalContext =
renderer.getRenderingContext();
- throw new RendererException( "File '" +
module.getSourceDirectory() + File.separator + doc
- + "' clashes with existing '" + originalDoc +
"'." );
- }
- //
-----------------------------------------------------------------------
- // Handle key without case differences
- //
-----------------------------------------------------------------------
- for ( Map.Entry<String, DocumentRenderer> entry :
files.entrySet() )
+ File originalDoc = new File( originalContext.getBasedir(),
originalContext.getInputName() );
+
+ throw new RendererException( "File '" +
module.getSourceDirectory() + File.separator + doc
+ + "' clashes with existing '" + originalDoc + "'." );
+ }
+ //
-----------------------------------------------------------------------
+ // Handle key without case differences
+ //
-----------------------------------------------------------------------
+ for ( Map.Entry<String, DocumentRenderer> entry :
files.entrySet() )
+ {
+ if ( entry.getKey().equalsIgnoreCase( key ) )
+ {
+ RenderingContext originalContext =
entry.getValue().getRenderingContext();
+
+ File originalDoc = new File(
originalContext.getBasedir(), originalContext.getInputName() );
+
+ if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
{
- if ( entry.getKey().equalsIgnoreCase( key ) )
- {
- RenderingContext originalContext =
entry.getValue().getRenderingContext();
-
- File originalDoc = new File(
originalContext.getBasedir(),
- originalContext.getInputName() );
-
- if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
- {
- throw new RendererException( "File '" +
module.getSourceDirectory() + File.separator
- + doc + "' clashes with existing '" +
originalDoc + "'." );
- }
-
- if ( getLogger().isWarnEnabled() )
- {
- getLogger().warn(
- "File '" +
module.getSourceDirectory() + File.separator + doc
- + "' could clash
with existing '" + originalDoc + "'." );
- }
- }
+ throw new RendererException( "File '" +
module.getSourceDirectory() + File.separator
+ + doc + "' clashes with existing '" +
originalDoc + "'." );
}
- files.put( key, new DoxiaDocumentRenderer( context ) );
+ if ( getLogger().isWarnEnabled() )
+ {
+ getLogger().warn( "File '" +
module.getSourceDirectory() + File.separator + doc
+ + "' could clash with existing '" +
originalDoc + "'." );
+ }
}
}
+
+ files.put( key, new DoxiaDocumentRenderer( context ) );
}
}
}
@@ -509,6 +496,7 @@ public class DefaultSiteRenderer
context.put( "locale", locale );
context.put( "supportedLocales", Collections.unmodifiableList(
siteRenderingContext.getSiteLocales() ) );
+ // doxiaSiteRendererVersion
InputStream inputStream = null;
try
{
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -24,7 +24,7 @@ import java.io.UnsupportedEncodingExcept
import java.io.Writer;
/**
- * Renders a page.
+ * Renders a page, 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$
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -24,7 +24,9 @@ import java.io.UnsupportedEncodingExcept
import java.io.Writer;
/**
- * Renders a page with Doxia.
+ * Renderer for a document that has a source file to be parsed by Doxia.
+ * Details about the source file are in {@link RenderingContext}, which is
expected to have
+ * a non-null parserId and extension.
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
* @version $Id$
Copied:
maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ExtraDoxiaModuleReference.java
(from r1720901,
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/ExtraDoxiaModuleReference.java?p2=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ExtraDoxiaModuleReference.java&p1=maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/ModuleReference.java&r1=1720901&r2=1720924&rev=1720924&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/ExtraDoxiaModuleReference.java
Sat Dec 19 13:44:56 2015
@@ -26,13 +26,13 @@ import java.io.File;
*
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
*/
-class ModuleReference
+class ExtraDoxiaModuleReference
{
private final String parserId;
private final File basedir;
- ModuleReference( String parserId, File basedir )
+ ExtraDoxiaModuleReference( String parserId, File basedir )
{
this.parserId = parserId;
this.basedir = basedir;
@@ -43,7 +43,7 @@ class ModuleReference
*
* @return Doxia parser id associated to this source module.
*/
- public String getParserId()
+ String getParserId()
{
return parserId;
}
@@ -53,7 +53,7 @@ class ModuleReference
*
* @return The base directory for module's source files.
*/
- public File getBasedir()
+ 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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -33,7 +33,8 @@ import org.apache.maven.doxia.site.decor
import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
/**
- * <p>Renderer interface.</p>
+ * <p>Site Renderer interface: render a collection of documents into a site,
ie decored with a site template
+ * (eventually packaged as skin).</p>
*
* @author <a href="mailto:eveni...@codehaus.org";>Emmanuel Venisse</a>
* @version $Id$
@@ -46,31 +47,31 @@ public interface Renderer
String ROLE = Renderer.class.getName();
/**
- * Render a collection of documents.
+ * Render a collection of documents into a site.
*
* @param documents the documents to render.
* @param siteRenderingContext the SiteRenderingContext to use.
* @param outputDirectory the output directory to write results.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it
bombs.
- * @throws java.io.IOException if it bombs.
+ * @throws RendererException if it bombs.
+ * @throws IOException if it bombs.
*/
void render( Collection<DocumentRenderer> documents, SiteRenderingContext
siteRenderingContext,
File outputDirectory )
throws RendererException, IOException;
/**
- * Generate a document.
+ * Generate a document output from a Doxia SiteRenderer Sink.
*
* @param writer the Writer to use.
- * @param sink the Sink to receive the events.
+ * @param sink the Site Renderer Sink to receive the Doxia events.
* @param siteRenderingContext the SiteRenderingContext to use.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it
bombs.
+ * @throws RendererException if it bombs.
*/
void generateDocument( Writer writer, SiteRendererSink sink,
SiteRenderingContext siteRenderingContext )
throws RendererException;
/**
- * Return a SiteRenderingContext for a site using a skin.
+ * Create a Site Rendering Context for a site using a skin.
*
* @param skinFile
* @param attributes
@@ -85,7 +86,7 @@ public interface Renderer
throws IOException;
/**
- * Return a SiteRenderingContext for a site using a local template.
+ * Create a Site Rendering Context for a site using a local template.
*
* @param templateFile
* @param skinFile
@@ -94,7 +95,7 @@ public interface Renderer
* @param defaultWindowTitle
* @param locale
* @return a SiteRenderingContext.
- * @throws java.net.MalformedURLException if it bombs.
+ * @throws MalformedURLException if it bombs.
*/
SiteRenderingContext createContextForTemplate( File templateFile, File
skinFile, Map<String, ?> attributes,
DecorationModel decoration,
String defaultWindowTitle,
@@ -107,7 +108,7 @@ public interface Renderer
* @param siteRenderingContext
* @param resourcesDirectory
* @param outputDirectory
- * @throws java.io.IOException if it bombs.
+ * @throws IOException if it bombs.
* @deprecated since 1.7, use copyResources without resourcesDirectory
parameter
*/
void copyResources( SiteRenderingContext siteRenderingContext, File
resourcesDirectory, File outputDirectory )
@@ -118,28 +119,29 @@ public interface Renderer
*
* @param siteRenderingContext
* @param outputDirectory
- * @throws java.io.IOException if it bombs.
+ * @throws IOException if it bombs.
* @since 1.7
*/
void copyResources( SiteRenderingContext siteRenderingContext, File
outputDirectory )
throws IOException;
/**
- * Return the document files in a Map.
+ * Locate Doxia document source files in the site source context.
*
* @param siteRenderingContext
- * @return the document files in a Map.
- * @throws java.io.IOException if it bombs.
- * @throws org.apache.maven.doxia.siterenderer.RendererException if it
bombs.
+ * @return the Doxia document renderers in a Map keyed by output file name.
+ * @throws IOException if it bombs.
+ * @throws RendererException if it bombs.
*/
Map<String, DocumentRenderer> locateDocumentFiles( SiteRenderingContext
siteRenderingContext )
throws IOException, RendererException;
/**
- * Render a document written in a Doxia markup language.
+ * Render a document written in a Doxia markup language. This method is an
internal method, used by
+ * {@link DoxiaDocumentRenderer}.
*
* @param writer the writer to render the document to.
- * @param renderingContext the document's rendering context
+ * @param renderingContext the document's rendering context, which is
expected to have a non-null parser id.
* @param siteContext the site's rendering context
* @throws RendererException if it bombs.
* @throws FileNotFoundException if it bombs.
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -28,7 +28,7 @@ import org.codehaus.plexus.util.PathTool
import org.codehaus.plexus.util.StringUtils;
/**
- * The rendering context of a document written in a Doxia supported markup.
+ * The rendering context of a document.
*
* @author <a href="mailto:ja...@maven.org";>Jason van Zyl</a>
* @version $Id$
@@ -51,35 +51,28 @@ public class RenderingContext
private Map<String, String> attributes;
/**
- * <p>Constructor for RenderingContext.</p>
+ * <p>
+ * Constructor for RenderingContext when document is not rendered from a
Doxia source.
+ * </p>
*
- * @param basedir a {@link java.io.File} object.
- * @param document a {@link java.lang.String} object.
+ * @param basedir the pseudo-source base directory.
+ * @param document the pseudo-source document name: will be used to
compute output name (same name with extension
+ * replaced with <code>.html</code>).
*/
public RenderingContext( File basedir, String document )
{
- this( basedir, document, null );
+ this( basedir, document, null, null );
}
/**
- * <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.
- */
- public RenderingContext( File basedir, String document, String parserId )
- {
- this( basedir, document, parserId, null );
-
- }
-
- /**
- * <p>Constructor for RenderingContext.</p>
+ * <p>
+ * Constructor for RenderingContext.
+ * </p>
*
* @param basedir the source base directory.
* @param document the source document name.
- * @param parserId the Doxia module parser id associated to this document.
+ * @param parserId the Doxia module parser id associated to this document,
may be null if document not rendered from
+ * a Doxia source.
* @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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -65,7 +65,7 @@ public class SiteRenderingContext
private Map<String, String> moduleExcludes;
- private List<ModuleReference> modules = new ArrayList<ModuleReference>();
+ private List<ExtraDoxiaModuleReference> modules = new
ArrayList<ExtraDoxiaModuleReference>();
private boolean validate;
@@ -276,24 +276,26 @@ public class SiteRenderingContext
}
/**
- * <p>addSiteDirectory.</p>
+ * Add a site directory, expected to have a Doxia Site layout, ie one
directory per Doxia parser module containing
+ * files with parser extension. Typical values are <code>src/site</code>
or <code>target/generated-site</code>.
*
- * @param file a {@link java.io.File} object.
+ * @param siteDirectory a {@link java.io.File} object.
*/
- public void addSiteDirectory( File file )
+ public void addSiteDirectory( File siteDirectory )
{
- this.siteDirectories.add( file );
+ this.siteDirectories.add( siteDirectory );
}
/**
- * Add a module source directory.
+ * Add a extra-module source directory: used for Maven 1.x
<code>${basedir}/xdocs</code> layout, which contains
+ * <code>xdoc</code> and <code>fml</code>.
*
* @param moduleBasedir The base directory for module's source files.
* @param moduleParserId module's Doxia parser id.
*/
public void addModuleDirectory( File moduleBasedir, String moduleParserId )
{
- this.modules.add( new ModuleReference( moduleParserId, moduleBasedir )
);
+ this.modules.add( new ExtraDoxiaModuleReference( moduleParserId,
moduleBasedir ) );
}
/**
@@ -311,7 +313,7 @@ public class SiteRenderingContext
*
* @return a {@link java.util.List} object.
*/
- public List<ModuleReference> getModules()
+ public List<ExtraDoxiaModuleReference> getModules()
{
return modules;
}
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -32,7 +32,7 @@ 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="http://jira.codehaus.org/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
*/
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=1720924&r1=1720923&r2=1720924&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
Sat Dec 19 13:44:56 2015
@@ -37,9 +37,16 @@ import org.codehaus.plexus.util.StringUt
/**
* Sink for site rendering of a document, to allow later merge document's
output with a template.
+ * During raw Doxia rendering, content is stored in multiple fields for later
use when incorporating
+ * into skin or template: title, date, authors, head, body
*
* @author <a href="mailto:eveni...@codehaus.org";>Emmanuel Venisse</a>
* @version $Id$
+ * @see #getTitle()
+ * @see #getDate()
+ * @see #getAuthors()
+ * @see #getHead()
+ * @see #getBody()
*/
@SuppressWarnings( "checkstyle:methodname" )
public class SiteRendererSink
Modified: maven/doxia/doxia-sitetools/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/pom.xml?rev=1720924&r1=1720923&r2=1720924&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/pom.xml (original)
+++ maven/doxia/doxia-sitetools/trunk/pom.xml Sat Dec 19 13:44:56 2015
@@ -265,8 +265,6 @@ under the License.
<!-- DOXIASITETOOLS-85 RenderingContext package changed -->
<exclude>org/apache/maven/doxia/siterenderer/*Renderer</exclude>
<exclude>org/apache/maven/doxia/siterenderer/sink/*</exclude>
- <!-- DOXIASITETOOLS-127 Renderer renamed to SiteRenderer -->
-
<exclude>org/apache/maven/doxia/siterenderer/*RendererException</exclude>
</excludes>
</configuration>
</execution>
