You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Anthony Whitford (JIRA)" <ji...@codehaus.org> on 2008/04/28 00:34:46 UTC
[jira] Created: (MJAVADOC-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Unable to differentiate JavaDoc reports when using multiple doclets
-------------------------------------------------------------------
Key: MJAVADOC-184
URL: http://jira.codehaus.org/browse/MJAVADOC-184
Project: Maven 2.x Javadoc Plugin
Issue Type: Improvement
Affects Versions: 2.4
Reporter: Anthony Whitford
If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MJAVADOC-184.
------------------------------------
Resolution: Not A Bug
Like I said, you need to add name and description parameters, similar to the following:
{noformat}
<reportSets>
<reportSet>
<id>jDoc1</id>
<reports>
<report>javadoc</report>
</reports>
<configuration>
<name>jdoc1</name>
<description>jdoc1</description>
</configuration>
</reportSet>
<reportSet>
<id>jdoc2</id>
<configuration>
<locale>en_US</locale>
<destDir>apidocs2</destDir>
<name>jdoc2</name>
<description>jdoc2</description>
</configuration>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
{noformat}
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
> Attachments: MJAVADOC-184 result.jpg, my-app.zip
>
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton updated MJAVADOC-184:
-------------------------------------
Attachment: MJAVADOC-184 result.jpg
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
> Attachments: MJAVADOC-184 result.jpg, my-app.zip
>
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=135246#action_135246 ]
Vincent Siveton commented on MJAVADOC-184:
------------------------------------------
Could you send us a test case?
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=136711#action_136711 ]
Vincent Siveton commented on MJAVADOC-184:
------------------------------------------
BTW you could always use the name parameter
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Anthony Whitford (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Anthony Whitford updated MJAVADOC-184:
--------------------------------------
Attachment: my-app.zip
I have attached a mini maven projec to demonstrate what I am talking about. It is not highly realistic because it simply calls the main javadoc twice -- in the real world, I use different doclets for each api set.
Unzip the project and run: {{mvn site}}
Then look at: {{target\site\project-reports.html}}
You will see two documents called _JavaDocs_, but no real way to distinguish them.
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
> Attachments: my-app.zip
>
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton updated MJAVADOC-184:
-------------------------------------
Attachment: MJAVADOC-184 result.jpg
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
> Attachments: MJAVADOC-184 result.jpg, my-app.zip
>
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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-184) Unable to differentiate JavaDoc
reports when using multiple doclets
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton updated MJAVADOC-184:
-------------------------------------
Attachment: (was: MJAVADOC-184 result.jpg)
> Unable to differentiate JavaDoc reports when using multiple doclets
> -------------------------------------------------------------------
>
> Key: MJAVADOC-184
> URL: http://jira.codehaus.org/browse/MJAVADOC-184
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Improvement
> Affects Versions: 2.4
> Reporter: Anthony Whitford
> Attachments: MJAVADOC-184 result.jpg, my-app.zip
>
>
> If you configure the javadoc plugin with a reportSet using 2 doclets (like the YDoc doclet, and the PDF doclet, for example), both reports appear on projects-reports.html with the same Document and Description. There is presently no way to differentiate them.
> I think a reasonable solution is to have the ability to overwrite the Document and Description for the generated reports page, so that I can label the PDF version as such.
--
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