You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Gabriel Forro (JIRA)" <ji...@codehaus.org> on 2009/05/05 11:59:44 UTC
[jira] Created: (MJAVADOC-230) aggregate report requires to have
aggregate=true configuration parameter
aggregate report requires to have aggregate=true configuration parameter
------------------------------------------------------------------------
Key: MJAVADOC-230
URL: http://jira.codehaus.org/browse/MJAVADOC-230
Project: Maven 2.x Javadoc Plugin
Issue Type: Bug
Affects Versions: 2.5
Environment: Maven 2.0.9
Windows XP SP2
Reporter: Gabriel Forro
Priority: Minor
Project setup: I have a multi-module project (standard nested layout). The reports are configured in the parent project. I use the "aggregate" report to create an aggregated javadoc by the maven-javadoc-plugin:
<reportSets>
<reportSet>
<reports>
<report>aggregate</report>
<reports>
</reportSet>
</reportSets>
Problem: The aggregate report is ignored, when I launch the "mvn site" command, unless the aggregated parameter is set to true in the maven-javadoc-plugin configuration. So the following setup is required in pom.xml:
<reportSets>
<reportSet>
<configuration>
<encoding>UTF-8</encoding>
<aggregate>true</aggregate>
</configuration>
<reports>
<report>aggregate</report>
<reports>
</reportSet>
</reportSets>
Desired functionality: Launch the aggregate goal, if it is declared in the report section. Do not require the aggregate parameter=true setting (it is a duplication and also the aggregate parameter is deprecated). The following setup should be enough in pom.xml:
<reportSets>
<reportSet>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
<reports>
<report>aggregate</report>
<reports>
</reportSet>
</reportSets>
Comment:
The aggregate goal works fine (it does not require to have the aggregate=true parameter), if it is launched directly. That is by the "mvn javadoc:aggregate" command.
It just does not work, when it is launched indirectly through the site plugin as a report.
--
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-230) aggregate report requires to have
aggregate=true configuration parameter
Posted by "Jeff Maxwell (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-230?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeff Maxwell updated MJAVADOC-230:
----------------------------------
Attachment: MJAVADOC-230-maven-javadoc-plugin.patch
I have created a patch
In {{org.apache.maven.plugin.javadoc.JavadocReport.canGenerateReport()}} {{isAggregator()}} is tested against the {{aggregate}} instance variable.
This is incorrect.
I believe the correct logic is as follows:
|| isAggregator || hasSourceFiles || isRootProject || Generate Report ||
|True|True|True|True|
|True|True|False|False|
|True|False|True|False|
|True|False|False|False|
|False|True|True|True|
|False|True|False|True|
|False|False|True|False|
|False|False|False|False|
> aggregate report requires to have aggregate=true configuration parameter
> ------------------------------------------------------------------------
>
> Key: MJAVADOC-230
> URL: http://jira.codehaus.org/browse/MJAVADOC-230
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Environment: Maven 2.0.9
> Windows XP SP2
> Reporter: Gabriel Forro
> Priority: Minor
> Attachments: MJAVADOC-230-maven-javadoc-plugin.patch
>
>
> Project setup: I have a multi-module project (standard nested layout). The reports are configured in the parent project. I use the "aggregate" report to create an aggregated javadoc by the maven-javadoc-plugin:
> <reportSets>
> <reportSet>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Problem: The aggregate report is ignored, when I launch the "mvn site" command, unless the aggregated parameter is set to true in the maven-javadoc-plugin configuration. So the following setup is required in pom.xml:
> <reportSets>
> <reportSet>
> <configuration>
> <encoding>UTF-8</encoding>
> <aggregate>true</aggregate>
> </configuration>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Desired functionality: Launch the aggregate goal, if it is declared in the report section. Do not require the aggregate parameter=true setting (it is a duplication and also the aggregate parameter is deprecated). The following setup should be enough in pom.xml:
> <reportSets>
> <reportSet>
> <configuration>
> <encoding>UTF-8</encoding>
> </configuration>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Comment:
> The aggregate goal works fine (it does not require to have the aggregate=true parameter), if it is launched directly. That is by the "mvn javadoc:aggregate" command.
> It just does not work, when it is launched indirectly through the site plugin as a report.
--
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-230) aggregate report requires to have
aggregate=true configuration parameter
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MJAVADOC-230?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MJAVADOC-230.
------------------------------------
Assignee: Vincent Siveton
Resolution: Fixed
Fix Version/s: 2.6
Patch applied in [r794114|http://svn.apache.org/viewvc?rev=794114&view=rev]
> aggregate report requires to have aggregate=true configuration parameter
> ------------------------------------------------------------------------
>
> Key: MJAVADOC-230
> URL: http://jira.codehaus.org/browse/MJAVADOC-230
> Project: Maven 2.x Javadoc Plugin
> Issue Type: Bug
> Affects Versions: 2.5
> Environment: Maven 2.0.9
> Windows XP SP2
> Reporter: Gabriel Forro
> Assignee: Vincent Siveton
> Priority: Minor
> Fix For: 2.6
>
> Attachments: MJAVADOC-230-maven-javadoc-plugin.patch
>
>
> Project setup: I have a multi-module project (standard nested layout). The reports are configured in the parent project. I use the "aggregate" report to create an aggregated javadoc by the maven-javadoc-plugin:
> <reportSets>
> <reportSet>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Problem: The aggregate report is ignored, when I launch the "mvn site" command, unless the aggregated parameter is set to true in the maven-javadoc-plugin configuration. So the following setup is required in pom.xml:
> <reportSets>
> <reportSet>
> <configuration>
> <encoding>UTF-8</encoding>
> <aggregate>true</aggregate>
> </configuration>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Desired functionality: Launch the aggregate goal, if it is declared in the report section. Do not require the aggregate parameter=true setting (it is a duplication and also the aggregate parameter is deprecated). The following setup should be enough in pom.xml:
> <reportSets>
> <reportSet>
> <configuration>
> <encoding>UTF-8</encoding>
> </configuration>
> <reports>
> <report>aggregate</report>
> <reports>
> </reportSet>
> </reportSets>
> Comment:
> The aggregate goal works fine (it does not require to have the aggregate=true parameter), if it is launched directly. That is by the "mvn javadoc:aggregate" command.
> It just does not work, when it is launched indirectly through the site plugin as a report.
--
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