You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2008/11/03 22:53:35 UTC
svn commit: r710182 - in /maven/jxr/trunk/maven-jxr-plugin/src:
main/java/org/apache/maven/plugin/jxr/ test/java/org/apache/maven/plugin/jxr/
test/resources/unit/default-configuration/
Author: hboutemy
Date: Mon Nov 3 13:53:34 2008
New Revision: 710182
URL: http://svn.apache.org/viewvc?rev=710182&view=rev
Log:
[JXR-67] use ${project.reporting.outputEncoding} as default value for "outputEncoding" parameter and default to UTF-8
Modified:
maven/jxr/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
maven/jxr/trunk/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java
maven/jxr/trunk/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml
Modified: maven/jxr/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java?rev=710182&r1=710181&r2=710182&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AbstractJxrReport.java Mon Nov 3 13:53:34 2008
@@ -39,6 +39,7 @@
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import org.codehaus.plexus.util.FileUtils;
+import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
/**
@@ -84,7 +85,7 @@
/**
* File output encoding.
*
- * @parameter default-value="ISO-8859-1"
+ * @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
*/
private String outputEncoding;
@@ -166,6 +167,17 @@
private boolean linkJavadoc;
/**
+ * Gets the effective reporting output files encoding.
+ *
+ * @return The effective reporting output file encoding, never <code>null</code>: defaults to
+ * <code>UTF-8</code> instead.
+ */
+ protected String getOutputEncoding()
+ {
+ return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
+ }
+
+ /**
* Compiles the list of directories which contain source files that will be included in the JXR report generation.
*
* @param sourceDirs the List of the source directories
@@ -263,7 +275,7 @@
jxr.setInputEncoding( inputEncoding );
jxr.setLocale( locale );
jxr.setLog( new PluginLogAdapter( getLog() ) );
- jxr.setOutputEncoding( outputEncoding );
+ jxr.setOutputEncoding( getOutputEncoding() );
jxr.setRevision( "HEAD" );
jxr.setJavadocLinkDir( getJavadocLocation() );
// Set include/exclude patterns on the jxr instance
Modified: maven/jxr/trunk/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java?rev=710182&r1=710181&r2=710182&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/JxrReportTest.java Mon Nov 3 13:53:34 2008
@@ -113,6 +113,8 @@
"target/test/unit/default-configuration/target/site/xref/def/configuration/App.html" ) );
assertTrue( str.toLowerCase().indexOf( "/apidocs/def/configuration/app.html\"".toLowerCase() ) != -1 );
+ // check if encoding is UTF-8, the default value
+ assertTrue( str.indexOf( "text/html; charset=UTF-8" ) != -1 );
}
/**
@@ -193,6 +195,8 @@
assertTrue( str.toLowerCase().indexOf(
"/apidocs/nojavadoclink/configuration/sample/sample.html\"".toLowerCase() ) == -1 );
+ // check if encoding is ISO-8859-1, like specified in the plugin configuration
+ assertTrue( str.indexOf( "text/html; charset=ISO-8859-1" ) != -1 );
}
/**
Modified: maven/jxr/trunk/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml?rev=710182&r1=710181&r2=710182&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/test/resources/unit/default-configuration/default-configuration-plugin-config.xml Mon Nov 3 13:53:34 2008
@@ -36,7 +36,6 @@
<outputDirectory>${basedir}/target/test/unit/default-configuration/target/site</outputDirectory>
<docTitle>Maven Jxr Plugin Default Configuration Test 1.0-SNAPSHOT Reference</docTitle>
<inputEncoding>ISO-8859-1</inputEncoding>
- <outputEncoding>ISO-8859-1</outputEncoding>
<sourceDirs>
<value>${basedir}/src/test/resources/unit/default-configuration</value>
</sourceDirs>