This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-pdf-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 25f5db3 added documentation about generated xdoc files for reports
25f5db3 is described below
commit 25f5db3dd8049d98cd487c1d5838fbbf1d019112
Author: Hervé Boutemy <hbout...@apache.org>
AuthorDate: Sun May 27 15:30:17 2018 +0200
added documentation about generated xdoc files for reports
---
pom.xml | 1 +
src/it/pdf-with-reporting-section/pom.xml | 5 -----
.../java/org/apache/maven/plugins/pdf/PdfMojo.java | 19 +++++++++++--------
3 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/pom.xml b/pom.xml
index d90fed9..fd2c995 100644
--- a/pom.xml
+++ b/pom.xml
@@ -362,6 +362,7 @@ under the License.
<plugin>
<artifactId>maven-invoker-plugin</artifactId>
<configuration>
+ <debug>false</debug>
<goals>
<goal>clean</goal>
<goal>${project.groupId}:${project.artifactId}:${project.version}:pdf</goal>
diff --git a/src/it/pdf-with-reporting-section/pom.xml
b/src/it/pdf-with-reporting-section/pom.xml
index dbe3162..8cd5bd6 100644
--- a/src/it/pdf-with-reporting-section/pom.xml
+++ b/src/it/pdf-with-reporting-section/pom.xml
@@ -80,11 +80,6 @@ under the License.
<reporting>
<plugins>
<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>2.6</version>
- </plugin>
- <plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>2.9</version>
<reportSets>
diff --git a/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java
b/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java
index 28ec6de..dc8cdbc 100644
--- a/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java
+++ b/src/main/java/org/apache/maven/plugins/pdf/PdfMojo.java
@@ -501,8 +501,10 @@ public class PdfMojo
copyResources( locale );
+ // generated xdoc sources for reports
generateMavenReports( locale );
+ // render all Doxia source files to pdf (were handwritten or
generated by reports)
DocumentRendererContext context = new DocumentRendererContext();
context.put( "project", project );
context.put( "settings", settings );
@@ -963,7 +965,7 @@ public class PdfMojo
}
/**
- * Generate all Maven reports defined in <code>${project.reporting}</code>
part
+ * Generate all Maven reports defined in <code>${project.reporting}</code>
to <code>xdoc</code> source
* only if <code>generateReports</code> is enabled.
*
* @param locale not null
@@ -998,7 +1000,8 @@ public class PdfMojo
}
/**
- * Generate the given Maven report only if it is not an external report
and the report could be generated.
+ * Generate the given Maven report to an xdoc source file,
+ * only if it is not an external report and the report could be generated.
*
* @param reportExecution not null
* @param locale not null
@@ -1085,11 +1088,11 @@ public class PdfMojo
StringWriter sw = new StringWriter();
- PdfXdocSink sink = null;
+ PdfXdocSink pdfXdocSink = null;
try
{
- sink = new PdfXdocSink( sw );
- renderReportToSink( reportExecution, locale, sink );
+ pdfXdocSink = new PdfXdocSink( sw );
+ renderReportToSink( reportExecution, locale, pdfXdocSink );
}
catch ( MavenReportException e )
{
@@ -1099,9 +1102,9 @@ public class PdfMojo
}
finally
{
- if ( sink != null )
+ if ( pdfXdocSink != null )
{
- sink.close();
+ pdfXdocSink.close();
}
}
@@ -1568,7 +1571,7 @@ public class PdfMojo
// ----------------------------------------------------------------------
/**
- * A sink to generate a Maven report as xdoc with some known workarounds.
+ * A sink to render a Maven report as a generated xdoc file, with some
known workarounds.
*
* @since 1.1
*/
--
To stop receiving notification emails like this one, please contact
hbout...@apache.org.
