Continuum reference docs

[Wendy Smoak-3]

I'm going to work on publishing reference docs (Javadoc, reports) for
Continuum under the maven.a.o/continuum/ref/$version url.

This weekend I configured UMLGraph to generate diagrams as part of
Javadoc for Archiva [1] and plan to do that also for Continuum.

[1] example:
http://maven.apache.org/archiva/ref/latest/apidocs/index.html?org/apache/maven/archiva/consumers/BaseConsumer.html

--
Wendy

[Wendy Smoak-3]

On 10/15/07, Wendy Smoak <wsmoak@...> wrote:
> I'm going to work on publishing reference docs (Javadoc, reports) for
> Continuum under the maven.a.o/continuum/ref/$version url.

Or not.  Any idea what this is about?

$ mvn site
...
[INFO] Building Maven Continuum Plugin
[INFO] ----------------------------------------------------------------------------
[INFO] No goals needed for project - skipping
[INFO] Setting property: classpath.resource.loader.class =>
'org.codehaus.plexus.velocity.ContextClassLoaderResourceLoader'.
[INFO] Setting property: velocimacro.messages.on => 'false'.
[INFO] Setting property: resource.loader => 'classpath'.
[INFO] Setting property: resource.manager.logwhenfound => 'false'.
[INFO] [site:site]
[INFO] Generate "JavaDocs" report.
1 error
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Error during page generation

Embedded error: Error rendering Maven report: Exit code: 1 -
/Users/wsmoak/svn/maven/continuum/continuum-data-management/data-management-redback-jdo/src/main/java/org/apache/maven/continuum/management/redback/LegacyJdoDataManagementTool.java:33:
cannot access org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata
bad class file:
/Users/wsmoak/svn/maven/continuum/continuum-data-management/redback-legacy/target/generated-sources/modello/org/codehaus/plexus/security/authorization/rbac/jdo/v0_9_0/RbacJdoModelModelloMetadata.java
file does not contain class
org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata
Please remove or make sure it appears in the correct subdirectory of
the classpath.
import org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata;
                                                                  ^

Command line was:"cd
/Users/wsmoak/svn/maven/continuum/target/site/apidocs &&
/System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Home/bin/javadoc"
@options @packages

--
Wendy

[Emmanuel Venisse]

I modified redback-legacy pom to fix it.

The problem was that we patch generated modello files in process-sources phase due to a bug in modellobut the javadoc reporting is executed in generate-sources phase so our patch wasn't applied.

Emmanuel

Wendy Smoak a écrit :

> On 10/15/07, Wendy Smoak <wsmoak@...> wrote:
>> I'm going to work on publishing reference docs (Javadoc, reports) for
>> Continuum under the maven.a.o/continuum/ref/$version url.
>
> Or not.  Any idea what this is about?
>
> $ mvn site
> ...
> [INFO] Building Maven Continuum Plugin
> [INFO] ----------------------------------------------------------------------------
> [INFO] No goals needed for project - skipping
> [INFO] Setting property: classpath.resource.loader.class =>
> 'org.codehaus.plexus.velocity.ContextClassLoaderResourceLoader'.
> [INFO] Setting property: velocimacro.messages.on => 'false'.
> [INFO] Setting property: resource.loader => 'classpath'.
> [INFO] Setting property: resource.manager.logwhenfound => 'false'.
> [INFO] [site:site]
> [INFO] Generate "JavaDocs" report.
> 1 error
> [INFO] ------------------------------------------------------------------------
> [ERROR] BUILD ERROR
> [INFO] ------------------------------------------------------------------------
> [INFO] Error during page generation
>
> Embedded error: Error rendering Maven report: Exit code: 1 -
> /Users/wsmoak/svn/maven/continuum/continuum-data-management/data-management-redback-jdo/src/main/java/org/apache/maven/continuum/management/redback/LegacyJdoDataManagementTool.java:33:
> cannot access org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata
> bad class file:
> /Users/wsmoak/svn/maven/continuum/continuum-data-management/redback-legacy/target/generated-sources/modello/org/codehaus/plexus/security/authorization/rbac/jdo/v0_9_0/RbacJdoModelModelloMetadata.java
> file does not contain class
> org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata
> Please remove or make sure it appears in the correct subdirectory of
> the classpath.
> import org.codehaus.plexus.security.authorization.rbac.jdo.v0_9_0.RbacJdoModelModelloMetadata;
>                                                                   ^
>
> Command line was:"cd
> /Users/wsmoak/svn/maven/continuum/target/site/apidocs &&
> /System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Home/bin/javadoc"
> @options @packages
>

[Wendy Smoak-3]

On 10/16/07, Emmanuel Venisse <emmanuel@...> wrote:
> I modified redback-legacy pom to fix it.
>
> The problem was that we patch generated modello files in process-sources phase due to a bug in modellobut the javadoc reporting is executed in generate-sources phase so our patch wasn't applied.

Thanks!  The site builds locally now, I'll give publishing it another try later.

--
Wendy

[Wendy Smoak-3]

On 10/16/07, Wendy Smoak <wsmoak@...> wrote:

> Thanks!  The site builds locally now, I'll give publishing it another try later.

Success!  It starts here:  http://maven.apache.org/continuum/ref/latest/

(As with Archiva, 'latest' is symlinked to the most recent snapshot
docs, in this case 1.1-beta-4.)

Some examples of the UMLGraph alternate doclet for Javadoc in action:

http://maven.apache.org/continuum/ref/latest/apidocs/org/apache/maven/continuum/release/ContinuumReleaseManager.html

http://maven.apache.org/continuum/ref/latest/apidocs/org/apache/maven/continuum/web/action/AddMavenProjectAction.html

This does introduce a dependency on GraphViz [1] in order to generate
the diagrams.  You need the 'dot' executable on your path.  I think
you can still build the Javadoc without it, you'll just get a broken
image.

[1] http://www.graphviz.org/

--
Wendy

[Emmanuel Venisse]

Wendy Smoak a écrit :

> On 10/16/07, Wendy Smoak <wsmoak@...> wrote:
>
>> Thanks!  The site builds locally now, I'll give publishing it another try later.
>
> Success!  It starts here:  http://maven.apache.org/continuum/ref/latest/
>
> (As with Archiva, 'latest' is symlinked to the most recent snapshot
> docs, in this case 1.1-beta-4.)
>
> Some examples of the UMLGraph alternate doclet for Javadoc in action:
>
> http://maven.apache.org/continuum/ref/latest/apidocs/org/apache/maven/continuum/release/ContinuumReleaseManager.html
>
> http://maven.apache.org/continuum/ref/latest/apidocs/org/apache/maven/continuum/web/action/AddMavenProjectAction.html
>
> This does introduce a dependency on GraphViz [1] in order to generate
> the diagrams.  You need the 'dot' executable on your path.  I think
> you can still build the Javadoc without it, you'll just get a broken
> image.
>
> [1] http://www.graphviz.org/
>

Thanks. I'll add more reports later.

Emmanuel