Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/apidocs/index-all.html ============================================================================== --- maven/website/components/plugins-archives/maven-site-plugin-LATEST/apidocs/index-all.html (original) +++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/apidocs/index-all.html Wed Apr 27 21:24:50 2022 @@ -4,7 +4,7 @@ <head> <!-- Generated by javadoc --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Index (Apache Maven Site Plugin 3.12.0 API)</title> +<title>Index (Apache Maven Site Plugin 4.0.0-M1 API)</title> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <script type="text/javascript" src="script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Index (Apache Maven Site Plugin 3.12.0 API)"; + parent.document.title="Index (Apache Maven Site Plugin 4.0.0-M1 API)"; } } catch(err) { @@ -78,32 +78,66 @@ <dd> <div class="block">Abstract base class for deploy mojos.</div> </dd> +<dt><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy"><span class="typeNameLink">AbstractDeployMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/deploy/package-summary.html">org.apache.maven.plugins.site.deploy</a></dt> +<dd> +<div class="block">Abstract base class for deploy mojos.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#AbstractDeployMojo--">AbstractDeployMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#AbstractDeployMojo--">AbstractDeployMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor"><span class="typeNameLink">AbstractSiteDescriptorMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/descriptor/package-summary.html">org.apache.maven.plugins.site.descriptor</a></dt> +<dd> +<div class="block">Abstract class to compute effective site decoration model for site descriptors.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor"><span class="typeNameLink">AbstractSiteDescriptorMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/descriptor/package-summary.html">org.apache.maven.plugins.site.descriptor</a></dt> <dd> <div class="block">Abstract class to compute effective site decoration model for site descriptors.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo--">AbstractSiteDescriptorMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor">AbstractSiteDescriptorMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#AbstractSiteDescriptorMojo--">AbstractSiteDescriptorMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor">AbstractSiteDescriptorMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site"><span class="typeNameLink">AbstractSiteMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/package-summary.html">org.apache.maven.plugins.site</a></dt> +<dd> +<div class="block">Base class for site mojos.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site"><span class="typeNameLink">AbstractSiteMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/package-summary.html">org.apache.maven.plugins.site</a></dt> <dd> <div class="block">Base class for site mojos.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#AbstractSiteMojo--">AbstractSiteMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#AbstractSiteMojo--">AbstractSiteMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">AbstractSiteRenderingMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> +<dd> +<div class="block">Base class for site rendering mojos.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">AbstractSiteRenderingMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> <dd> <div class="block">Base class for site rendering mojos.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#AbstractSiteRenderingMojo--">AbstractSiteRenderingMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#AbstractSiteRenderingMojo--">AbstractSiteRenderingMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy"><span class="typeNameLink">AbstractStagingMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/deploy/package-summary.html">org.apache.maven.plugins.site.deploy</a></dt> +<dd> +<div class="block">Abstract base class for staging mojos.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy"><span class="typeNameLink">AbstractStagingMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/deploy/package-summary.html">org.apache.maven.plugins.site.deploy</a></dt> <dd> <div class="block">Abstract base class for staging mojos.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#AbstractStagingMojo--">AbstractStagingMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#AbstractStagingMojo--">AbstractStagingMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#appendSlash-java.lang.String-">appendSlash(String)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Make sure the given URL ends with a slash.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#appendSlash-java.lang.String-">appendSlash(String)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Make sure the given URL ends with a slash.</div> @@ -118,6 +152,14 @@ <dd> <div class="block">Go through the collection of reports and put each report into a list for the appropriate category.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#categoriseReports-java.util.Collection-">categoriseReports(Collection<MavenReport>)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Go through the collection of reports and put each report into a list for the appropriate category.</div> +</dd> +<dt><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">CategorySummaryDocumentRenderer</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> +<dd> +<div class="block">Renders a Maven report.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">CategorySummaryDocumentRenderer</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> <dd> <div class="block">Renders a Maven report.</div> @@ -126,11 +168,20 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer-org.apache.maven.doxia.siterenderer.RenderingContext-java.lang.String-java.lang.String-java.lang.String-org.codehaus.plexus.i18n.I18N-java.util.List-org.apache.maven.plugin.logging.Log-">CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List<MavenReport>, Log)</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer-org.apache.maven.doxia.siterenderer.RenderingContext-java.lang.String-java.lang.String-java.lang.String-org.codehaus.plexus.i18n.I18N-java.util.List-">CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List<MavenReport>)</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer-org.apache.maven.doxia.siterenderer.RenderingContext-java.lang.String-java.lang.String-java.lang.String-org.codehaus.plexus.i18n.I18N-java.util.List-org.apache.maven.plugin.logging.Log-">CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List<MavenReport>, Log)</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#checkInputEncoding--">checkInputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#checkInputEncoding--">checkInputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#contextualize-org.codehaus.plexus.context.Context-">contextualize(Context)</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#contextualize-org.codehaus.plexus.context.Context-">contextualize(Context)</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#createSiteRenderingContext-java.util.Locale-">createSiteRenderingContext(Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#createSiteRenderingContext-java.util.Locale-">createSiteRenderingContext(Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> </dl> <a name="I:D"> <!-- --> @@ -141,18 +192,36 @@ <dd> <div class="block">The String "staging/".</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#DEFAULT_STAGING_DIRECTORY">DEFAULT_STAGING_DIRECTORY</a></span> - Static variable in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a></dt> +<dd> +<div class="block">The String "staging/".</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#destroy--">destroy()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#destroy--">destroy()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> <dd> <div class="block">Deploy directly to the current project's distribution management site.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> +<dd> +<div class="block">Deploy directly to the current project's distribution management site.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#determineDeploySite--">determineDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a></dt> @@ -160,10 +229,24 @@ <div class="block">By default, staging mojos will get their top distribution management site url by getting top parent with the same site, which is a good heuristics.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractStagingMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractStagingMojo</a></dt> +<dd> +<div class="block">By default, staging mojos will get their top distribution management site url by getting top parent + with the same site, which is a good heuristics.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> <dd> <div class="block">Deploy distribution site url is directly the current project value.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> +<dd> +<div class="block">Deploy distribution site url is directly the current project value.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> +<dd> +<div class="block">If <code>stagingSiteURL</code> is configured, top most parent with same staging site url + will be used.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#determineTopDistributionManagementSiteUrl--">determineTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> <dd> <div class="block">If <code>stagingSiteURL</code> is configured, top most parent with same staging site url @@ -171,18 +254,32 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter(ServletRequest, ServletResponse, FilterChain)</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter(ServletRequest, ServletResponse, FilterChain)</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run"><span class="typeNameLink">DoxiaBean</span></a> - Class in <a href="org/apache/maven/plugins/site/run/package-summary.html">org.apache.maven.plugins.site.run</a></dt> +<dd> +<div class="block">Bean to handle Doxia in a servlet context attribute</div> +</dd> <dt><a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run"><span class="typeNameLink">DoxiaBean</span></a> - Class in <a href="org/apache/maven/plugins/site/run/package-summary.html">org.apache.maven.plugins.site.run</a></dt> <dd> <div class="block">Bean to handle Doxia in a servlet context attribute</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#DoxiaBean-org.apache.maven.doxia.siterenderer.SiteRenderingContext-java.util.Map-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">DoxiaBean(SiteRenderingContext, Map<String, DocumentRenderer>, SiteRenderingContext)</a></span> - Constructor for class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#DoxiaBean-org.apache.maven.doxia.siterenderer.SiteRenderingContext-java.util.Map-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">DoxiaBean(SiteRenderingContext, Map<String, DocumentRenderer>, SiteRenderingContext)</a></span> - Constructor for class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run"><span class="typeNameLink">DoxiaFilter</span></a> - Class in <a href="org/apache/maven/plugins/site/run/package-summary.html">org.apache.maven.plugins.site.run</a></dt> +<dd> +<div class="block">Render a page as requested.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run"><span class="typeNameLink">DoxiaFilter</span></a> - Class in <a href="org/apache/maven/plugins/site/run/package-summary.html">org.apache.maven.plugins.site.run</a></dt> <dd> <div class="block">Render a page as requested.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#DoxiaFilter--">DoxiaFilter()</a></span> - Constructor for class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#DoxiaFilter--">DoxiaFilter()</a></span> - Constructor for class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> </dl> <a name="I:E"> <!-- --> @@ -194,18 +291,37 @@ <div class="block">Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of <code>site.xml</code>, for the first locale.</div> </dd> +<dt><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor"><span class="typeNameLink">EffectiveSiteMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/descriptor/package-summary.html">org.apache.maven.plugins.site.descriptor</a></dt> +<dd> +<div class="block">Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of + <code>site.xml</code>, for the first locale.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html#EffectiveSiteMojo--">EffectiveSiteMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor">EffectiveSiteMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html#EffectiveSiteMojo--">EffectiveSiteMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor">EffectiveSiteMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/HelpMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/HelpMojo.html" title="class in org.apache.maven.plugins.site.deploy">HelpMojo</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/HelpMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/HelpMojo.html" title="class in org.apache.maven.plugins.site.deploy">HelpMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor">EffectiveSiteMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor">EffectiveSiteMojo</a></dt> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorAttachMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorAttachMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/SiteRunMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/SiteRunMojo.html" title="class in org.apache.maven.plugins.site.run">SiteRunMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/SiteRunMojo.html#execute--">execute()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/SiteRunMojo.html" title="class in org.apache.maven.plugins.site.run">SiteRunMojo</a></dt> <dd> </dd> </dl> @@ -218,18 +334,38 @@ <dd> <div class="block">Generates a sitemap.xml in targetDir/xdoc/.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMap.html#generate-org.apache.maven.doxia.site.decoration.DecorationModel-java.io.File-java.util.Locale-">generate(DecorationModel, File, Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMap.html" title="class in org.apache.maven.plugins.site.render">SiteMap</a></dt> +<dd> +<div class="block">Generates a sitemap.xml in targetDir/xdoc/.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#generatedSiteDirectory">generatedSiteDirectory</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Directory containing generated documentation in source format (Doxia supported markup).</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#generatedSiteDirectory">generatedSiteDirectory</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">Directory containing generated documentation in source format (Doxia supported markup).</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#getArtifactType--">getArtifactType()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#getArtifactType--">getArtifactType()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getBaseVersion--">getBaseVersion()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getBaseVersion--">getBaseVersion()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#getClassifier--">getClassifier()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteJarMojo.html#getClassifier--">getClassifier()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteJarMojo.html" title="class in org.apache.maven.plugins.site.render">SiteJarMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getContext--">getContext()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getContext--">getContext()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getDeployModuleDirectory--">getDeployModuleDirectory()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Find the relative path between the distribution URLs of the top site and the current project.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getDeployModuleDirectory--">getDeployModuleDirectory()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Find the relative path between the distribution URLs of the top site and the current project.</div> @@ -238,8 +374,18 @@ <dd> <div class="block">Get the site used for deployment, with its id to look up credential settings and the target URL for the deploy.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getDeploySite--">getDeploySite()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Get the site used for deployment, with its id to look up credential settings and the target URL for the deploy.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getDocuments--">getDocuments()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getDocuments--">getDocuments()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMap.html#getEncoding--">getEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMap.html" title="class in org.apache.maven.plugins.site.render">SiteMap</a></dt> +<dd> +<div class="block">Get the encoding to use when writing the output file.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMap.html#getEncoding--">getEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMap.html" title="class in org.apache.maven.plugins.site.render">SiteMap</a></dt> <dd> <div class="block">Get the encoding to use when writing the output file.</div> @@ -248,52 +394,106 @@ <dd> <div class="block">Find the build directory of the execution root project in the reactor.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#getExecutionRootBuildDirectory--">getExecutionRootBuildDirectory()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> +<dd> +<div class="block">Find the build directory of the execution root project in the reactor.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getGeneratedSiteContext--">getGeneratedSiteContext()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaBean.html#getGeneratedSiteContext--">getGeneratedSiteContext()</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaBean.html" title="class in org.apache.maven.plugins.site.run">DoxiaBean</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMap.html#getI18n--">getI18n()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMap.html" title="class in org.apache.maven.plugins.site.render">SiteMap</a></dt> <dd> <div class="block">Get the value of i18n.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMap.html#getI18n--">getI18n()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMap.html" title="class in org.apache.maven.plugins.site.render">SiteMap</a></dt> +<dd> +<div class="block">Get the value of i18n.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getInputEncoding--">getInputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">Gets the input files encoding.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getInputEncoding--">getInputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Gets the input files encoding.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getKey--">getKey()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getKey--">getKey()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#getLocales--">getLocales()</a></span> - Method in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#getLocales--">getLocales()</a></span> - Method in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getLocalFilename-org.apache.maven.artifact.repository.ArtifactRepository-">getLocalFilename(ArtifactRepository)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getLocalFilename-org.apache.maven.artifact.repository.ArtifactRepository-">getLocalFilename(ArtifactRepository)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#getMavenVersion--">getMavenVersion()</a></span> - Method in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#getMavenVersion--">getMavenVersion()</a></span> - Method in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getOutputEncoding--">getOutputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Gets the effective reporting output files encoding.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getOutputEncoding--">getOutputEncoding()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">Gets the effective reporting output files encoding.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#getOutputName--">getOutputName()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#getOutputName--">getOutputName()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getOutputName--">getOutputName()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getOutputName--">getOutputName()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#getProject--">getProject()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#getProject--">getProject()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getProxyInfo-org.apache.maven.wagon.repository.Repository-org.apache.maven.artifact.manager.WagonManager-">getProxyInfo(Repository, WagonManager)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Get proxy information.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getProxyInfo-org.apache.maven.wagon.repository.Repository-org.apache.maven.artifact.manager.WagonManager-">getProxyInfo(Repository, WagonManager)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Get proxy information.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getRemoteFilename--">getRemoteFilename()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#getRemoteFilename--">getRemoteFilename()</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#getRenderingContext--">getRenderingContext()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#getRenderingContext--">getRenderingContext()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getRenderingContext--">getRenderingContext()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getRenderingContext--">getRenderingContext()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getReportMojoInfo--">getReportMojoInfo()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#getReportMojoInfo--">getReportMojoInfo()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getReports--">getReports()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#getReports--">getReports()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#getSession--">getSession()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#getSession--">getSession()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getSite-org.apache.maven.project.MavenProject-">getSite(MavenProject)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Extract the distributionManagement site from the given MavenProject.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getSite-org.apache.maven.project.MavenProject-">getSite(MavenProject)</a></span> - Static method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Extract the distributionManagement site from the given MavenProject.</div> @@ -302,6 +502,14 @@ <dd> <div class="block">Get the top distribution management site url, used for module relative path calculations.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getTopDistributionManagementSiteUrl--">getTopDistributionManagementSiteUrl()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Get the top distribution management site url, used for module relative path calculations.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getTopLevelProject-org.apache.maven.project.MavenProject-">getTopLevelProject(MavenProject)</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Extract the distributionManagement site of the top level parent of the given MavenProject.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#getTopLevelProject-org.apache.maven.project.MavenProject-">getTopLevelProject(MavenProject)</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Extract the distributionManagement site of the top level parent of the given MavenProject.</div> @@ -317,6 +525,13 @@ <div class="block">Display help information on maven-site-plugin.<br> Call <code>mvn site:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> </dd> +<dt><a href="org/apache/maven/plugins/site/deploy/HelpMojo.html" title="class in org.apache.maven.plugins.site.deploy"><span class="typeNameLink">HelpMojo</span></a> - Class in <a href="org/apache/maven/plugins/site/deploy/package-summary.html">org.apache.maven.plugins.site.deploy</a></dt> +<dd> +<div class="block">Display help information on maven-site-plugin.<br> + Call <code>mvn site:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/HelpMojo.html#HelpMojo--">HelpMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/HelpMojo.html" title="class in org.apache.maven.plugins.site.deploy">HelpMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/HelpMojo.html#HelpMojo--">HelpMojo()</a></span> - Constructor for class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/HelpMojo.html" title="class in org.apache.maven.plugins.site.deploy">HelpMojo</a></dt> <dd> </dd> </dl> @@ -329,28 +544,54 @@ <dd> <div class="block">Internationalization.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#i18n">i18n</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> +<div class="block">Internationalization.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#I18N_DOXIA_CONTEXTS_KEY">I18N_DOXIA_CONTEXTS_KEY</a></span> - Static variable in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#I18N_DOXIA_CONTEXTS_KEY">I18N_DOXIA_CONTEXTS_KEY</a></span> - Static variable in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#init-javax.servlet.FilterConfig-">init(FilterConfig)</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#init-javax.servlet.FilterConfig-">init(FilterConfig)</a></span> - Method in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> +<div class="block">Detect if the mojo is staging or deploying.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> <div class="block">Detect if the mojo is staging or deploying.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteDeployMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageDeployMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html#isDeploy--">isDeploy()</a></span> - Method in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/SiteStageMojo.html" title="class in org.apache.maven.plugins.site.deploy">SiteStageMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#isExternalReport--">isExternalReport()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#isExternalReport--">isExternalReport()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#isExternalReport--">isExternalReport()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#isExternalReport--">isExternalReport()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#isOverwrite--">isOverwrite()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#isOverwrite--">isOverwrite()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#isOverwrite--">isOverwrite()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#isOverwrite--">isOverwrite()</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> </dl> <a name="I:L"> <!-- --> @@ -359,10 +600,24 @@ <dl> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#LOCALES_LIST_KEY">LOCALES_LIST_KEY</a></span> - Static variable in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/run/DoxiaFilter.html#LOCALES_LIST_KEY">LOCALES_LIST_KEY</a></span> - Static variable in class org.apache.maven.plugins.site.run.<a href="org/apache/maven/plugins/site/run/DoxiaFilter.html" title="class in org.apache.maven.plugins.site.run">DoxiaFilter</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#localRepository">localRepository</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> <dd> <div class="block">The local repository.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#localRepository">localRepository</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> +<div class="block">The local repository.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#locateDocuments-org.apache.maven.doxia.siterenderer.SiteRenderingContext-java.util.List-java.util.Locale-">locateDocuments(SiteRenderingContext, List<MavenReportExecution>, Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Locate every document to be rendered for given locale: + handwritten content, ie Doxia files, + reports, + "Project Information" and "Project Reports" category summaries. + </div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#locateDocuments-org.apache.maven.doxia.siterenderer.SiteRenderingContext-java.util.List-java.util.Locale-">locateDocuments(SiteRenderingContext, List<MavenReportExecution>, Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">Locate every document to be rendered for given locale: @@ -379,6 +634,14 @@ If the report is not yet in the map of documents, add it together with a suitable renderer </div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#locateReports-java.util.List-java.util.Map-java.util.Locale-">locateReports(List<MavenReportExecution>, Map<String, DocumentRenderer>, Locale)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Go through the list of reports and process each one like this: + + Add the report to a map of reports keyed by filename having the report itself as value + If the report is not yet in the map of documents, add it together with a suitable renderer + </div> +</dd> </dl> <a name="I:M"> <!-- --> @@ -387,12 +650,24 @@ <dl> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#mavenReportExecutor">mavenReportExecutor</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#mavenReportExecutor">mavenReportExecutor</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#mavenSession">mavenSession</a></span> - Variable in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html#mavenSession">mavenSession</a></span> - Variable in class org.apache.maven.plugins.site.deploy.<a href="org/apache/maven/plugins/site/deploy/AbstractDeployMojo.html" title="class in org.apache.maven.plugins.site.deploy">AbstractDeployMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#mavenSession">mavenSession</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">The current Maven session.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#mavenSession">mavenSession</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">The current Maven session.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#merge-org.apache.maven.artifact.metadata.ArtifactMetadata-">merge(ArtifactMetadata)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#merge-org.apache.maven.repository.legacy.metadata.ArtifactMetadata-">merge(ArtifactMetadata)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#merge-org.apache.maven.artifact.metadata.ArtifactMetadata-">merge(ArtifactMetadata)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html#merge-org.apache.maven.repository.legacy.metadata.ArtifactMetadata-">merge(ArtifactMetadata)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/SiteDescriptorArtifactMetadata.html" title="class in org.apache.maven.plugins.site.descriptor">SiteDescriptorArtifactMetadata</a></dt> @@ -417,6 +692,14 @@ <dd> <div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html#output">output</a></span> - Variable in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.html" title="class in org.apache.maven.plugins.site.descriptor">EffectiveSiteMojo</a></dt> +<dd> +<div class="block">Optional parameter to write the output of this help in a given file, instead of writing to the console.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#outputDirectory">outputDirectory</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> +<dd> +<div class="block">Directory where the project sites and report distributions will be generated (as html/css/...).</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/SiteMojo.html#outputDirectory">outputDirectory</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/SiteMojo.html" title="class in org.apache.maven.plugins.site.render">SiteMojo</a></dt> <dd> <div class="block">Directory where the project sites and report distributions will be generated (as html/css/...).</div> @@ -429,12 +712,20 @@ <dl> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#populateReportItems-org.apache.maven.doxia.site.decoration.DecorationModel-java.util.Locale-java.util.Map-">populateReportItems(DecorationModel, Locale, Map<String, MavenReport>)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#populateReportItems-org.apache.maven.doxia.site.decoration.DecorationModel-java.util.Locale-java.util.Map-">populateReportItems(DecorationModel, Locale, Map<String, MavenReport>)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#prepareDecorationModel-java.util.Locale-">prepareDecorationModel(Locale)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor">AbstractSiteDescriptorMojo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html#prepareDecorationModel-java.util.Locale-">prepareDecorationModel(Locale)</a></span> - Method in class org.apache.maven.plugins.site.descriptor.<a href="org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.html" title="class in org.apache.maven.plugins.site.descriptor">AbstractSiteDescriptorMojo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#project">project</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> <dd> <div class="block">The Maven project.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#project">project</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> +<div class="block">The Maven project.</div> +</dd> </dl> <a name="I:R"> <!-- --> @@ -445,16 +736,34 @@ <dd> <div class="block">The reactor projects.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/AbstractSiteMojo.html#reactorProjects">reactorProjects</a></span> - Variable in class org.apache.maven.plugins.site.<a href="org/apache/maven/plugins/site/AbstractSiteMojo.html" title="class in org.apache.maven.plugins.site">AbstractSiteMojo</a></dt> +<dd> +<div class="block">The reactor projects.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#renderDocument-java.io.Writer-org.apache.maven.doxia.siterenderer.Renderer-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">renderDocument(Writer, Renderer, SiteRenderingContext)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#renderDocument-java.io.Writer-org.apache.maven.doxia.siterenderer.Renderer-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">renderDocument(Writer, Renderer, SiteRenderingContext)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">CategorySummaryDocumentRenderer</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#renderDocument-java.io.Writer-org.apache.maven.doxia.siterenderer.Renderer-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">renderDocument(Writer, Renderer, SiteRenderingContext)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#renderDocument-java.io.Writer-org.apache.maven.doxia.siterenderer.Renderer-org.apache.maven.doxia.siterenderer.SiteRenderingContext-">renderDocument(Writer, Renderer, SiteRenderingContext)</a></span> - Method in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> +<dt><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">ReportDocumentRenderer</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> +<dd> +<div class="block">Renders a Maven report in a Doxia site.</div> +</dd> <dt><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render"><span class="typeNameLink">ReportDocumentRenderer</span></a> - Class in <a href="org/apache/maven/plugins/site/render/package-summary.html">org.apache.maven.plugins.site.render</a></dt> <dd> <div class="block">Renders a Maven report in a Doxia site.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer-org.apache.maven.reporting.exec.MavenReportExecution-org.apache.maven.doxia.siterenderer.RenderingContext-org.apache.maven.plugin.logging.Log-">ReportDocumentRenderer(MavenReportExecution, RenderingContext, Log)</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer-org.apache.maven.reporting.exec.MavenReportExecution-org.apache.maven.doxia.siterenderer.RenderingContext-org.apache.maven.plugin.logging.Log-">ReportDocumentRenderer(MavenReportExecution, RenderingContext, Log)</a></span> - Constructor for class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/ReportDocumentRenderer.html" title="class in org.apache.maven.plugins.site.render">ReportDocumentRenderer</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#reports">reports</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> +<dd> +<div class="block">Reports (Maven 2).</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html#reports">reports</a></span> - Variable in class org.apache.maven.plugins.site.render.<a href="org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html" title="class in org.apache.maven.plugins.site.render">AbstractSiteRenderingMojo</a></dt> <dd> <div class="block">Reports (Maven 2).</div> @@ -463,6 +772,12 @@ <dd> <div class="block">Remote repositories used for the project.</div> </dd>
[... 254 lines stripped ...]