diff --git a/javadoc/plugin.jelly b/javadoc/plugin.jelly index 6c435d93..61b60620 100644 --- a/javadoc/plugin.jelly +++ b/javadoc/plugin.jelly @@ -66,9 +66,17 @@ - + + ${maven.javadoc.links} + + Linking with API information from ${link.trim()} ... + + - + ${maven.javadoc.offlineLinks} + + Linking offline API information from ${link.trim()} ... + @@ -119,9 +127,33 @@ + + - + + + + + + + + + + + + + + + + + + + + + + + diff --git a/javadoc/xdocs/properties.xml b/javadoc/xdocs/properties.xml index 6b59fddf..2bb6e865 100644 --- a/javadoc/xdocs/properties.xml +++ b/javadoc/xdocs/properties.xml @@ -58,6 +58,57 @@ from the project descriptor. + + maven.javadoc.links + Yes + +

+ Comma separated list of URLs to create links to javadoc output of + other packages in online mode (maven.online.mode=true), works like + the "-link" option of the javadoc command. +

+

+ The URLs must link to a directory where the javadoc generated file + "package-list" is accesible for the package. +

+

Example:

+ +maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apache.org/apidocs/ + + + + + maven.javadoc.offlineLinks + Yes + +

+ Comma seperated list of URLs to create links to javadoc output of + other packages in offline mode (maven.online.mode=false), works like + the "-linkoffline" option of the javadoc command. + Comma seperated list of URLs to create links to javadoc output of + other packages, works like the "-link" option of the javadoc command. +

+

+ The URLs must link to a directory where the javadoc generated file + "package-list" is accesible for the package. +

+

Example (generates offline links in offline mode):

+ +maven.javadoc.offlineLinks=/opt/java-apidoc/j2sdk1.4.1/docs/api/, /cvsroot/maven/target/docs/apidocs/ + +

+ Generation of online javadoc links in offline mode is also possible. + You need to provide the online URL plus the a offline directory + resource for "package-list". URL and directory need to be seperated + by the "#" character. +

+

Example (generates online links in offline mode):

+ +maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apidoc/j2sdk1.4.1/docs/api/, \ + http://maven.apache.org/apidocs/#/cvsroot/maven/target/docs/apidocs/ + + + maven.javadoc.private Yes