You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Francois Fernandes (JIRA)" <ji...@codehaus.org> on 2007/07/11 15:07:13 UTC
[jira] Created: (MJAVADOC-133) Javadoc fails if footer contains
newlines
Javadoc fails if footer contains newlines
-----------------------------------------
Key: MJAVADOC-133
URL: http://jira.codehaus.org/browse/MJAVADOC-133
Project: Maven 2.x Javadoc Plugin
Issue Type: Bug
Affects Versions: 2.2
Environment: Windows XP, java 1.6 u1
Reporter: Francois Fernandes
The current version of the javadoc plugin fails if the footer specified for the project contains newline characters:
{code:xml}
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
<configuration>
<excludePackageNames>*.internal*</excludePackageNames>
<footer>
<![CDATA[
<table border="0" cellpadding="0">
<tr><td><img src="{@docRoot}/icon.gif" width="32" /></td><td> All rights reserved.</td></tr></table>
]]>
</footer>
</configuration>
</plugin>
{code}
The resulting output is as follows:
[INFO] Error while creating archive:Exit code: 1 - javadoc: error - Illegal package name: "<tr><td><img"
javadoc: error - Illegal package name: "src="
javadoc: error - Illegal package name: "{@docRoot}/icon.gif"
javadoc: error - Illegal package name: "width="
javadoc: error - Illegal package name: "32"
javadoc: error - Illegal package name: "/></td><td>Copyright"
javadoc: error - Illegal package name: "&"
{noformat}
{noformat}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Closed: (MJAVADOC-133) Javadoc fails if footer contains
newlines
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-133?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MJAVADOC-133.
------------------------------------
Assignee: Vincent Siveton
Resolution: Fixed
Fix Version/s: 2.3
Replaced all \n by nothing in the header and footer parameter
> Javadoc fails if footer contains newlines
> -----------------------------------------
>
> Key: MJAVADOC-133
> URL: http://jira.codehaus.org/browse/MJAVADOC-133
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.2
> Environment: Windows XP, java 1.6 u1
> Reporter: Francois Fernandes
> Assignee: Vincent Siveton
> Fix For: 2.3
>
> Attachments: options, packages, testcase.zip
>
>
> The current version of the javadoc plugin fails if the footer specified for the project contains newline characters:
> {code:xml}
> <plugin>
> <artifactId>maven-javadoc-plugin</artifactId>
> <executions>
> <execution>
> <goals>
> <goal>jar</goal>
> </goals>
> <phase>package</phase>
> </execution>
> </executions>
> <configuration>
> <excludePackageNames>*.internal*</excludePackageNames>
> <footer>
> <![CDATA[
> <table border="0" cellpadding="0">
> <tr><td><img src="{@docRoot}/icon.gif" width="32" /></td><td> All rights reserved.</td></tr></table>
> ]]>
> </footer>
> </configuration>
> </plugin>
> {code}
> The resulting output is as follows:
> [INFO] Error while creating archive:Exit code: 1 - javadoc: error - Illegal package name: "<tr><td><img"
> javadoc: error - Illegal package name: "src="
> javadoc: error - Illegal package name: "{@docRoot}/icon.gif"
> javadoc: error - Illegal package name: "width="
> javadoc: error - Illegal package name: "32"
> javadoc: error - Illegal package name: "/></td><td>Copyright"
> javadoc: error - Illegal package name: "&"
> {noformat}
> {noformat}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (MJAVADOC-133) Javadoc fails if footer contains
newlines
Posted by "Francois Fernandes (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-133?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Francois Fernandes updated MJAVADOC-133:
----------------------------------------
Attachment: packages
options
testcase.zip
I've attached a simple testcase which will fail using maven 2.0.7. The generated argument files are attached too.
When this testcase is beeing executed, the following output will be on the commandline:
{noformat}
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'assembly'.
[INFO] ----------------------------------------------------------------------------
[INFO] Building my-artifact
[INFO] task-segment: [assembly:assembly] (aggregator-style)
[INFO] ----------------------------------------------------------------------------
[INFO] Preparing assembly:assembly
[INFO] ----------------------------------------------------------------------------
[INFO] Building my-artifact
[INFO] ----------------------------------------------------------------------------
[INFO] [resources:resources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:compile]
[INFO] Nothing to compile - all classes are up to date
[INFO] [resources:testResources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:testCompile]
[INFO] No sources to compile
[INFO] [surefire:test]
[INFO] No tests to run.
[INFO] [jar:jar]
[INFO] Building jar: C:\temp\my-artifact\target\my-artifact-1.0-SNAPSHOT.jar
[INFO] Preparing javadoc:jar
[WARNING] Removing: jar from forked lifecycle, to prevent recursive invocation.
[INFO] No goals needed for project - skipping
[INFO] [javadoc:jar {execution: default}]
Loading source files for package com.mycompany...
Loading source files for package com.mycompany.group1...
Loading source files for package com.mycompany.group2...
Loading source files for package com.mycompany.group2.sub1...
Loading source files for package com.mycompany.group2.sub2...
Loading source files for package com.mycompany.group2.sub3...
12 errors
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error while creating archive:Exit code: 1 - javadoc: error - Illegal package name: "<tr>"
javadoc: error - Illegal package name: "<td><img"
javadoc: error - Illegal package name: "src="
javadoc: error - Illegal package name: "{@docRoot}/icon.gif"
javadoc: error - Illegal package name: "width="
javadoc: error - Illegal package name: "32"
javadoc: error - Illegal package name: "/></td>"
javadoc: error - Illegal package name: "<td>Copyright"
javadoc: error - Illegal package name: "&"
javadoc: error - Illegal package name: "</tr>"
javadoc: error - Illegal package name: "</table>"
javadoc: error - Illegal package name: ""
Command line was:C:\Programme\Java\jdk1.6.0\jre\..\bin\javadoc.exe @options @packages
[INFO] ------------------------------------------------------------------------
[INFO] For more information, run Maven with the -e switch
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3 seconds
[INFO] Finished at: Wed Jul 11 15:50:13 CEST 2007
[INFO] Final Memory: 6M/14M
[INFO] ------------------------------------------------------------------------
{noformat}
> Javadoc fails if footer contains newlines
> -----------------------------------------
>
> Key: MJAVADOC-133
> URL: http://jira.codehaus.org/browse/MJAVADOC-133
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.2
> Environment: Windows XP, java 1.6 u1
> Reporter: Francois Fernandes
> Attachments: options, packages, testcase.zip
>
>
> The current version of the javadoc plugin fails if the footer specified for the project contains newline characters:
> {code:xml}
> <plugin>
> <artifactId>maven-javadoc-plugin</artifactId>
> <executions>
> <execution>
> <goals>
> <goal>jar</goal>
> </goals>
> <phase>package</phase>
> </execution>
> </executions>
> <configuration>
> <excludePackageNames>*.internal*</excludePackageNames>
> <footer>
> <![CDATA[
> <table border="0" cellpadding="0">
> <tr><td><img src="{@docRoot}/icon.gif" width="32" /></td><td> All rights reserved.</td></tr></table>
> ]]>
> </footer>
> </configuration>
> </plugin>
> {code}
> The resulting output is as follows:
> [INFO] Error while creating archive:Exit code: 1 - javadoc: error - Illegal package name: "<tr><td><img"
> javadoc: error - Illegal package name: "src="
> javadoc: error - Illegal package name: "{@docRoot}/icon.gif"
> javadoc: error - Illegal package name: "width="
> javadoc: error - Illegal package name: "32"
> javadoc: error - Illegal package name: "/></td><td>Copyright"
> javadoc: error - Illegal package name: "&"
> {noformat}
> {noformat}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (MJAVADOC-133) Javadoc fails if footer contains
newlines
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_101913 ]
Vincent Siveton commented on MJAVADOC-133:
------------------------------------------
Could you provide us options and packages files with the debug parameter?
http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html#How%20to%20know%20exactly%20the%20Javadoc%20command%20line
> Javadoc fails if footer contains newlines
> -----------------------------------------
>
> Key: MJAVADOC-133
> URL: http://jira.codehaus.org/browse/MJAVADOC-133
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.2
> Environment: Windows XP, java 1.6 u1
> Reporter: Francois Fernandes
>
> The current version of the javadoc plugin fails if the footer specified for the project contains newline characters:
> {code:xml}
> <plugin>
> <artifactId>maven-javadoc-plugin</artifactId>
> <executions>
> <execution>
> <goals>
> <goal>jar</goal>
> </goals>
> <phase>package</phase>
> </execution>
> </executions>
> <configuration>
> <excludePackageNames>*.internal*</excludePackageNames>
> <footer>
> <![CDATA[
> <table border="0" cellpadding="0">
> <tr><td><img src="{@docRoot}/icon.gif" width="32" /></td><td> All rights reserved.</td></tr></table>
> ]]>
> </footer>
> </configuration>
> </plugin>
> {code}
> The resulting output is as follows:
> [INFO] Error while creating archive:Exit code: 1 - javadoc: error - Illegal package name: "<tr><td><img"
> javadoc: error - Illegal package name: "src="
> javadoc: error - Illegal package name: "{@docRoot}/icon.gif"
> javadoc: error - Illegal package name: "width="
> javadoc: error - Illegal package name: "32"
> javadoc: error - Illegal package name: "/></td><td>Copyright"
> javadoc: error - Illegal package name: "&"
> {noformat}
> {noformat}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira