You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "André Fügenschuh (JIRA)" <ji...@codehaus.org> on 2010/10/26 13:46:05 UTC

[jira] Created: (MSITE-518) Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.

Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.
-------------------------------------------------------------------------------------------------------

                 Key: MSITE-518
                 URL: http://jira.codehaus.org/browse/MSITE-518
             Project: Maven 2.x Site Plugin
          Issue Type: Bug
          Components: inheritance, multi module
    Affects Versions: 3.0-beta-3
         Environment: Windows Vista x64, JDK 6u22, Maven 3.0
            Reporter: André Fügenschuh
         Attachments: maven3-site-javadoc-testcase.zip

With a +multi-module project design+ (cf. attached testcase):
{noformat}
- parent        (pom)
  + library     (pom)  // javadoc:aggregate
    + module-a  (jar)
    + module-b  (jar)
  + application (jar)  // javadoc:javadoc
{noformat}
run
{{mvn site}} | {{mvn -DstagingDirectory=\[dir\] site:stage}}
at _parent_ level.

+Result:+
Aggregated javadocs for _library_ are *not* generated (but are properly done if {{mvn site}} is run at _library_ level itself), while javadocs at _application_ level are generated.

OT: as appropriate {{<modules>}} sections are declared (cf. attached testcase), {{mvn compile}} runs as expected at _parent_ level.

This is a follow-up to MJAVADOC-181, which, although marked as resolved, has never been working for me using the _old_ site/reports configuration for Maven 2.2.1 / Site plugin 2.1.1.


-- 
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] Moved: (MJAVADOC-311) Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MJAVADOC-311?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lukas Theussl moved MSITE-518 to MJAVADOC-311:
----------------------------------------------

          Component/s:     (was: multi module)
                           (was: inheritance)
    Affects Version/s:     (was: 3.0-beta-3)
                       2.7
                  Key: MJAVADOC-311  (was: MSITE-518)
              Project: Maven 2.x Javadoc Plugin  (was: Maven 2.x and 3.x Site Plugin)

> Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.
> -------------------------------------------------------------------------------------------------------
>
>                 Key: MJAVADOC-311
>                 URL: http://jira.codehaus.org/browse/MJAVADOC-311
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 2.7
>         Environment: Windows Vista x64, JDK 6u22, Maven 3.0
>            Reporter: André Fügenschuh
>         Attachments: maven3-site-javadoc-testcase.zip
>
>
> With a +multi-module project design+ (cf. attached testcase):
> {noformat}
> - parent        (pom)
>   + library     (pom)  // javadoc:aggregate
>     + module-a  (jar)
>     + module-b  (jar)
>   + application (jar)  // javadoc:javadoc
> {noformat}
> run
> {{mvn site}} | {{mvn -DstagingDirectory=\[dir\] site:stage}}
> at _parent_ level.
> +Result:+
> Aggregated javadocs for _library_ are *not* generated (but are properly done if {{mvn site}} is run at _library_ level itself), while javadocs at _application_ level are generated.
> OT: as appropriate {{<modules>}} sections are declared (cf. attached testcase), {{mvn compile}} runs as expected at _parent_ level.
> This is a follow-up to MJAVADOC-181, which, although marked as resolved, has never been working for me using the _old_ site/reports configuration for Maven 2.2.1 / Site plugin 2.1.1.

-- 
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: (MSITE-518) Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.

Posted by "André Fügenschuh (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MSITE-518?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=241140#action_241140 ] 

André Fügenschuh commented on MSITE-518:
----------------------------------------

Some further investigations:
1)
Using {{mvn site}} apidocs *are* generated at (*wrong*) _library.modules-\[a|b\]_ level,
using {{mvn site:stage}} _library_'s apidocs are *not* generated at all.

Caused by automatic (inherited?) invocation at the very end of the reactor run:
{noformat}
...
[INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.7:javadoc'
has not be previously called for the project: 'foo.library:module-a:jar:3.0-SNAPSHOT'.
Trying to invoke it...
[INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.7:javadoc'
has not be previously called for the project: 'foo.library:module-b:jar:3.0-SNAPSHOT'.
Trying to invoke it...
...
{noformat}
2)
Trying to break inheritance in the _library_ pom with the {{<inherited>}} element, it appears that it's not
allowed at any level: neither at _javadoc_ {{<reportPlugin>}} nor at its {{<reportSet>}}.
{noformat}
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site (default-site)
on project library: Unable to parse configuration of mojo org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site
for parameter plugin: Cannot find setter nor field in org.apache.maven.plugins.site.ReportPlugin for 'inherited' -> [Help 1]
...
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site (default-site)
on project parent: Unable to parse configuration of mojo org.apache.maven.plugins:maven-site-plugin:3.0-beta-3:site
for parameter reportSet: Cannot find setter nor field in org.apache.maven.plugins.site.ReportSet for 'inherited' -> [Help 1]
{noformat}
Question: is this a) by design, b) simply yet missing, or c) a bug?


> Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.
> -------------------------------------------------------------------------------------------------------
>
>                 Key: MSITE-518
>                 URL: http://jira.codehaus.org/browse/MSITE-518
>             Project: Maven 2.x Site Plugin
>          Issue Type: Bug
>          Components: inheritance, multi module
>    Affects Versions: 3.0-beta-3
>         Environment: Windows Vista x64, JDK 6u22, Maven 3.0
>            Reporter: André Fügenschuh
>         Attachments: maven3-site-javadoc-testcase.zip
>
>
> With a +multi-module project design+ (cf. attached testcase):
> {noformat}
> - parent        (pom)
>   + library     (pom)  // javadoc:aggregate
>     + module-a  (jar)
>     + module-b  (jar)
>   + application (jar)  // javadoc:javadoc
> {noformat}
> run
> {{mvn site}} | {{mvn -DstagingDirectory=\[dir\] site:stage}}
> at _parent_ level.
> +Result:+
> Aggregated javadocs for _library_ are *not* generated (but are properly done if {{mvn site}} is run at _library_ level itself), while javadocs at _application_ level are generated.
> OT: as appropriate {{<modules>}} sections are declared (cf. attached testcase), {{mvn compile}} runs as expected at _parent_ level.
> This is a follow-up to MJAVADOC-181, which, although marked as resolved, has never been working for me using the _old_ site/reports configuration for Maven 2.2.1 / Site plugin 2.1.1.

-- 
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-311) Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.

Posted by "Kennard Consulting (JIRA)" <ji...@codehaus.org>.
    [ https://jira.codehaus.org/browse/MJAVADOC-311?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=279497#comment-279497 ] 

Kennard Consulting commented on MJAVADOC-311:
---------------------------------------------

+1 for me, too. This issue is complicating my Metawidget (http://metawidget.org) builds. I have to do...

	<modules>
		<module>documentation/reference</module>
		<module>examples</module>
		<module>integration-tests</module>
		<!-- Run separately until MJAVADOC-311 <module>website</module> -->
	</modules>

...in my parent POM, and...

	<plugin>
		<artifactId>maven-javadoc-plugin</artifactId>
		<inherited>false</inherited>
		<configuration>
			<aggregate>true</aggregate>
			...
		</configuration>
		<!-- mvn javadoc:aggregate must be manually run at *this* level (not parent POM) for JavaDoc generation to work. See MJAVADOC-311 -->
	</plugin>

...in my child POM. This is not ideal.


> Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.
> -------------------------------------------------------------------------------------------------------
>
>                 Key: MJAVADOC-311
>                 URL: https://jira.codehaus.org/browse/MJAVADOC-311
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 2.7
>         Environment: Windows Vista x64, JDK 6u22, Maven 3.0
>            Reporter: André Fügenschuh
>         Attachments: maven3-site-javadoc-testcase.zip
>
>
> With a +multi-module project design+ (cf. attached testcase):
> {noformat}
> - parent        (pom)
>   + library     (pom)  // javadoc:aggregate
>     + module-a  (jar)
>     + module-b  (jar)
>   + application (jar)  // javadoc:javadoc
> {noformat}
> run
> {{mvn site}} | {{mvn -DstagingDirectory=\[dir\] site:stage}}
> at _parent_ level.
> +Result:+
> Aggregated javadocs for _library_ are *not* generated (but are properly done if {{mvn site}} is run at _library_ level itself), while javadocs at _application_ level are generated.
> OT: as appropriate {{<modules>}} sections are declared (cf. attached testcase), {{mvn compile}} runs as expected at _parent_ level.
> This is a follow-up to MJAVADOC-181, which, although marked as resolved, has never been working for me using the _old_ site/reports configuration for Maven 2.2.1 / Site plugin 2.1.1.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] Commented: (MJAVADOC-311) Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.

Posted by "Chris Wilton (JIRA)" <ji...@codehaus.org>.
    [ https://jira.codehaus.org/browse/MJAVADOC-311?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=279496#comment-279496 ] 

Chris Wilton commented on MJAVADOC-311:
---------------------------------------

I can confirm this behaviour.

If I add the javadoc plugin configuration to the {{<reporting>}} section of the _parent_ pom, then the aggregated javadocs are created when {{mvn site}} is run at the parent level. But they are linked to the _parent_ project and we don't want them there, we want them in the _library_ module's project reports.

If the javadoc configuration is instead added to the {{<reporting>}} section of the _library_ pom, then the aggregated javadocs are not created at all if {{mvn site}} is run at the _parent_ level. They are created only if I run {{mvn site}} at the _library_ level.

Currently, as a workaround in my project, I am running {{mvn site}} at both the _parent_ and the _library_ level, one after the other. But that does not play nicely with Hudson/Jenkins scheduled site builds - I get wrong URL links and breadcrumbs in the library module. So I have to create and deploy the site manually.

> Aggregated javadoc report not generated for multi-module project at sub-level if run from parent level.
> -------------------------------------------------------------------------------------------------------
>
>                 Key: MJAVADOC-311
>                 URL: https://jira.codehaus.org/browse/MJAVADOC-311
>             Project: Maven 2.x Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 2.7
>         Environment: Windows Vista x64, JDK 6u22, Maven 3.0
>            Reporter: André Fügenschuh
>         Attachments: maven3-site-javadoc-testcase.zip
>
>
> With a +multi-module project design+ (cf. attached testcase):
> {noformat}
> - parent        (pom)
>   + library     (pom)  // javadoc:aggregate
>     + module-a  (jar)
>     + module-b  (jar)
>   + application (jar)  // javadoc:javadoc
> {noformat}
> run
> {{mvn site}} | {{mvn -DstagingDirectory=\[dir\] site:stage}}
> at _parent_ level.
> +Result:+
> Aggregated javadocs for _library_ are *not* generated (but are properly done if {{mvn site}} is run at _library_ level itself), while javadocs at _application_ level are generated.
> OT: as appropriate {{<modules>}} sections are declared (cf. attached testcase), {{mvn compile}} runs as expected at _parent_ level.
> This is a follow-up to MJAVADOC-181, which, although marked as resolved, has never been working for me using the _old_ site/reports configuration for Maven 2.2.1 / Site plugin 2.1.1.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira