You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ke...@apache.org on 2005/09/13 19:06:17 UTC
svn commit: r280592 -
/maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
Author: kenney
Date: Tue Sep 13 10:06:14 2005
New Revision: 280592
URL: http://svn.apache.org/viewcvs?rev=280592&view=rev
Log:
Fix MNG-873
Modified:
maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
Modified: maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=280592&r1=280591&r2=280592&view=diff
==============================================================================
--- maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original)
+++ maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Tue Sep 13 10:06:14 2005
@@ -74,9 +74,6 @@
/** Default bottom */
private static final String DEFAULT_BOTTOM = "Copyright ${project.inceptionYear-currentYear} ${project.organization.name}. All Rights Reserved.";
- /** Default bottom */
- private static final String DEFAULT_DESTDIR = "${project.build.directory}/site/apidocs";
-
/** Default doctitle */
private static final String DEFAULT_DOCTITLE = "${windowtitle}";
@@ -93,10 +90,13 @@
// ----------------------------------------------------------------------
/**
- * @parameter expression="${project.build.directory}/site"
+ * Specifies the destination directory where javadoc saves the generated HTML files.
+ * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
+ *
+ * @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/javadoc/"
* @required
*/
- private String outputDirectory;
+ private File outputDirectory;
/**
* @parameter expression="${component.org.codehaus.doxia.site.renderer.SiteRenderer}"
@@ -292,14 +292,6 @@
private String charset = "ISO-8859-1";
/**
- * Specifies the destination directory where javadoc saves the generated HTML files.
- * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
- *
- * @parameter expression="${destDir}" default-value="${project.build.directory}/site/apidocs"
- */
- private String destDir;
-
- /**
* Enables deep copying of "doc-files" directories.
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs">docfilessubdirs</a>.
*
@@ -563,7 +555,7 @@
*/
protected String getOutputDirectory()
{
- return outputDirectory;
+ return outputDirectory.getAbsoluteFile().toString();
}
/**
@@ -642,7 +634,16 @@
}
}
- File javadocDirectory = new File( getProject().getBuild().getDirectory() + "/javadoc" );
+ File javadocDirectory = getReportOutputDirectory();
+
+ if ( ! javadocDirectory.equals( getOutputDirectory() ) )
+ {
+ // we're in site-embedded report mode, so Doxia has set the
+ // reportOutputDirectory to the basedir of the site.
+ // Append 'apidocs'.
+ javadocDirectory = new File( javadocDirectory, "apidocs" );
+ }
+
if ( fileList != null && fileList.length != 0 )
{
StringBuffer files = new StringBuffer();
@@ -761,12 +762,7 @@
}
bottom += ". All Rights Reserved.";
}
- if ( destDir.equals( DEFAULT_DESTDIR ) )
- {
- File outputDir = new File( getReportOutputDirectory().getAbsolutePath() + "/apidocs" );
- outputDir.mkdirs();
- destDir = outputDir.getAbsolutePath();
- }
+
if ( StringUtils.isEmpty( stylesheetfile ) )
{
stylesheetfile = javadocDirectory + File.separator + DEFAULT_CSS_NAME;
@@ -785,7 +781,7 @@
addArgIfNotEmpty( arguments, "-bottom", bottom );
addArgIf( arguments, breakiterator, "-breakiterator", 1.4f );
addArgIfNotEmpty( arguments, "-charset", charset );
- addArgIfNotEmpty( arguments, "-d", destDir );
+ addArgIfNotEmpty( arguments, "-d", javadocDirectory.toString() );
addArgIf( arguments, docfilessubdirs, "-docfilessubdirs", 1.4f );
addArgIfNotEmpty( arguments, "-docencoding", docencoding );
addArgIfNotEmpty( arguments, "-doctitle", doctitle );
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r280592 -
/maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
Posted by Kenney Westerhof <fo...@neonics.com>.
On Wed, 14 Sep 2005, Brett Porter wrote:
Will do!
-- Kenney
> In future, can you explain what this is so JIRA doesn't need to be
> consulted? Thanks.
>
> - Brett
>
> kenney@apache.org wrote:
>
> >Author: kenney
> >Date: Tue Sep 13 10:06:14 2005
> >New Revision: 280592
> >
> >URL: http://svn.apache.org/viewcvs?rev=280592&view=rev
> >Log:
> >Fix MNG-873
> >
> >Modified:
> > maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
> >
> >Modified: maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
> >URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=280592&r1=280591&r2=280592&view=diff
> >==============================================================================
> >--- maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original)
> >+++ maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Tue Sep 13 10:06:14 2005
> >@@ -74,9 +74,6 @@
> > /** Default bottom */
> > private static final String DEFAULT_BOTTOM = "Copyright ${project.inceptionYear-currentYear} ${project.organization.name}. All Rights Reserved.";
> >
> >- /** Default bottom */
> >- private static final String DEFAULT_DESTDIR = "${project.build.directory}/site/apidocs";
> >-
> > /** Default doctitle */
> > private static final String DEFAULT_DOCTITLE = "${windowtitle}";
> >
> >@@ -93,10 +90,13 @@
> > // ----------------------------------------------------------------------
> >
> > /**
> >- * @parameter expression="${project.build.directory}/site"
> >+ * Specifies the destination directory where javadoc saves the generated HTML files.
> >+ * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
> >+ *
> >+ * @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/javadoc/"
> > * @required
> > */
> >- private String outputDirectory;
> >+ private File outputDirectory;
> >
> > /**
> > * @parameter expression="${component.org.codehaus.doxia.site.renderer.SiteRenderer}"
> >@@ -292,14 +292,6 @@
> > private String charset = "ISO-8859-1";
> >
> > /**
> >- * Specifies the destination directory where javadoc saves the generated HTML files.
> >- * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
> >- *
> >- * @parameter expression="${destDir}" default-value="${project.build.directory}/site/apidocs"
> >- */
> >- private String destDir;
> >-
> >- /**
> > * Enables deep copying of "doc-files" directories.
> > * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs">docfilessubdirs</a>.
> > *
> >@@ -563,7 +555,7 @@
> > */
> > protected String getOutputDirectory()
> > {
> >- return outputDirectory;
> >+ return outputDirectory.getAbsoluteFile().toString();
> > }
> >
> > /**
> >@@ -642,7 +634,16 @@
> > }
> > }
> >
> >- File javadocDirectory = new File( getProject().getBuild().getDirectory() + "/javadoc" );
> >+ File javadocDirectory = getReportOutputDirectory();
> >+
> >+ if ( ! javadocDirectory.equals( getOutputDirectory() ) )
> >+ {
> >+ // we're in site-embedded report mode, so Doxia has set the
> >+ // reportOutputDirectory to the basedir of the site.
> >+ // Append 'apidocs'.
> >+ javadocDirectory = new File( javadocDirectory, "apidocs" );
> >+ }
> >+
> > if ( fileList != null && fileList.length != 0 )
> > {
> > StringBuffer files = new StringBuffer();
> >@@ -761,12 +762,7 @@
> > }
> > bottom += ". All Rights Reserved.";
> > }
> >- if ( destDir.equals( DEFAULT_DESTDIR ) )
> >- {
> >- File outputDir = new File( getReportOutputDirectory().getAbsolutePath() + "/apidocs" );
> >- outputDir.mkdirs();
> >- destDir = outputDir.getAbsolutePath();
> >- }
> >+
> > if ( StringUtils.isEmpty( stylesheetfile ) )
> > {
> > stylesheetfile = javadocDirectory + File.separator + DEFAULT_CSS_NAME;
> >@@ -785,7 +781,7 @@
> > addArgIfNotEmpty( arguments, "-bottom", bottom );
> > addArgIf( arguments, breakiterator, "-breakiterator", 1.4f );
> > addArgIfNotEmpty( arguments, "-charset", charset );
> >- addArgIfNotEmpty( arguments, "-d", destDir );
> >+ addArgIfNotEmpty( arguments, "-d", javadocDirectory.toString() );
> > addArgIf( arguments, docfilessubdirs, "-docfilessubdirs", 1.4f );
> > addArgIfNotEmpty( arguments, "-docencoding", docencoding );
> > addArgIfNotEmpty( arguments, "-doctitle", doctitle );
> >
> >
> >
> >---------------------------------------------------------------------
> >To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >For additional commands, e-mail: dev-help@maven.apache.org
> >
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
--
Kenney Westerhof
http://www.neonics.com
GPG public key: http://www.gods.nl/~forge/kenneyw.key
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r280592 - /maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
Posted by Brett Porter <br...@apache.org>.
In future, can you explain what this is so JIRA doesn't need to be
consulted? Thanks.
- Brett
kenney@apache.org wrote:
>Author: kenney
>Date: Tue Sep 13 10:06:14 2005
>New Revision: 280592
>
>URL: http://svn.apache.org/viewcvs?rev=280592&view=rev
>Log:
>Fix MNG-873
>
>Modified:
> maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
>
>Modified: maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
>URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=280592&r1=280591&r2=280592&view=diff
>==============================================================================
>--- maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original)
>+++ maven/components/trunk/maven-plugins/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Tue Sep 13 10:06:14 2005
>@@ -74,9 +74,6 @@
> /** Default bottom */
> private static final String DEFAULT_BOTTOM = "Copyright ${project.inceptionYear-currentYear} ${project.organization.name}. All Rights Reserved.";
>
>- /** Default bottom */
>- private static final String DEFAULT_DESTDIR = "${project.build.directory}/site/apidocs";
>-
> /** Default doctitle */
> private static final String DEFAULT_DOCTITLE = "${windowtitle}";
>
>@@ -93,10 +90,13 @@
> // ----------------------------------------------------------------------
>
> /**
>- * @parameter expression="${project.build.directory}/site"
>+ * Specifies the destination directory where javadoc saves the generated HTML files.
>+ * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
>+ *
>+ * @parameter expression="${destDir}" alias="destDir" default-value="${project.build.directory}/javadoc/"
> * @required
> */
>- private String outputDirectory;
>+ private File outputDirectory;
>
> /**
> * @parameter expression="${component.org.codehaus.doxia.site.renderer.SiteRenderer}"
>@@ -292,14 +292,6 @@
> private String charset = "ISO-8859-1";
>
> /**
>- * Specifies the destination directory where javadoc saves the generated HTML files.
>- * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#d">d</a>.
>- *
>- * @parameter expression="${destDir}" default-value="${project.build.directory}/site/apidocs"
>- */
>- private String destDir;
>-
>- /**
> * Enables deep copying of "doc-files" directories.
> * See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#docfilessubdirs">docfilessubdirs</a>.
> *
>@@ -563,7 +555,7 @@
> */
> protected String getOutputDirectory()
> {
>- return outputDirectory;
>+ return outputDirectory.getAbsoluteFile().toString();
> }
>
> /**
>@@ -642,7 +634,16 @@
> }
> }
>
>- File javadocDirectory = new File( getProject().getBuild().getDirectory() + "/javadoc" );
>+ File javadocDirectory = getReportOutputDirectory();
>+
>+ if ( ! javadocDirectory.equals( getOutputDirectory() ) )
>+ {
>+ // we're in site-embedded report mode, so Doxia has set the
>+ // reportOutputDirectory to the basedir of the site.
>+ // Append 'apidocs'.
>+ javadocDirectory = new File( javadocDirectory, "apidocs" );
>+ }
>+
> if ( fileList != null && fileList.length != 0 )
> {
> StringBuffer files = new StringBuffer();
>@@ -761,12 +762,7 @@
> }
> bottom += ". All Rights Reserved.";
> }
>- if ( destDir.equals( DEFAULT_DESTDIR ) )
>- {
>- File outputDir = new File( getReportOutputDirectory().getAbsolutePath() + "/apidocs" );
>- outputDir.mkdirs();
>- destDir = outputDir.getAbsolutePath();
>- }
>+
> if ( StringUtils.isEmpty( stylesheetfile ) )
> {
> stylesheetfile = javadocDirectory + File.separator + DEFAULT_CSS_NAME;
>@@ -785,7 +781,7 @@
> addArgIfNotEmpty( arguments, "-bottom", bottom );
> addArgIf( arguments, breakiterator, "-breakiterator", 1.4f );
> addArgIfNotEmpty( arguments, "-charset", charset );
>- addArgIfNotEmpty( arguments, "-d", destDir );
>+ addArgIfNotEmpty( arguments, "-d", javadocDirectory.toString() );
> addArgIf( arguments, docfilessubdirs, "-docfilessubdirs", 1.4f );
> addArgIfNotEmpty( arguments, "-docencoding", docencoding );
> addArgIfNotEmpty( arguments, "-doctitle", doctitle );
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org