You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by J....@flagstar.com on 2008/08/19 23:11:03 UTC
maven-javadoc-plugin and custom stylesheet
I am having difficulties getting the maven-javadoc-plugin to utilize my
custom stylesheet.
(I am new to Maven)
In pom.xml, I have:
<project>
...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<reportSets>
<reportSet>
<id>html</id>
<configuration>
<stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
...
</configuration>
</reportSet>
</reportSets>
</plugins>
</reporting>
...
</project>
----------------------
If I invoke
mvn clean site
my stylesheet file is utilized:
Building tree for all the packages and classes...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\com/fsb/commons/configuration/\SofaConfiguration.html...
...
Copying file c:\ws\SofaCommonsMvn\src\main\javadoc\stylesheet.css to
file c:\ws\SofaCommonsMvn\target\site\apidocs\stylesheet.css...
...
Building index for all the packages and classes...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
Building index for all classes...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
----------------------
If I then invoke:
rm -rf target/site/apidocs ; mvn javadoc:javadoc
my stylesheet is NOT utilized:
Building tree for all the packages and classes...
...
Building index for all the packages and classes...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
Building index for all classes...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
Generating
c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
Generating c:/ws/SofaCommonsMvn/target/site/apidocs\stylesheet.css...
Thoughts? Am I using these goals incorrectly?
J. Thomas Halliley
IT Architecture & Infrastructure Team
Flagstar Bank
This e-mail may contain data that is confidential, proprietary or
non-public personal information, as that term is defined in the
Gramm-Leach-Bliley Act (collectively, Confidential Information).
The Confidential Information is disclosed conditioned upon your
agreement that you will treat it confidentially and in accordance
with applicable law, ensure that such data isn't used or disclosed
except for the limited purpose for which it's being provided and
will notify and cooperate with us regarding any requested or
unauthorized disclosure or use of any Confidential Information.
By accepting and reviewing the Confidential information, you agree
to indemnify us against any losses or expenses, including
attorney's fees that we may incur as a result of any unauthorized
use or disclosure of this data due to your acts or omissions. If a
party other than the intended recipient receives this e-mail, he or
she is requested to instantly notify us of the erroneous delivery
and return to us all data so delivered.
Re: maven-javadoc-plugin and custom stylesheet
Posted by Nick Stolwijk <ni...@gmail.com>.
Oh, and by the way, this kind of questions should go the Maven User list.
The issues list is for notifications which are send by Jira. The dev list is
for discussions about the development of Maven.
Hth,
Nick Stolwijk
~Java Developer~
Iprofs BV.
Claus Sluterweg 125
2012 WS Haarlem
www.iprofs.nl
On Tue, Aug 19, 2008 at 11:11 PM, <J....@flagstar.com> wrote:
> I am having difficulties getting the maven-javadoc-plugin to utilize my
> custom stylesheet.
> (I am new to Maven)
>
> In pom.xml, I have:
>
> <project>
> ...
> <reporting>
> <plugins>
> <plugin>
> <groupId>org.apache.maven.plugins</groupId>
> <artifactId>maven-javadoc-plugin</artifactId>
> <reportSets>
> <reportSet>
> <id>html</id>
> <configuration>
>
> <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
> <overview>${basedir}/src/main/javadoc/overview.html</overview>
> ...
> </configuration>
> </reportSet>
> </reportSets>
> </plugins>
> </reporting>
> ...
> </project>
>
> ----------------------
> If I invoke
> mvn clean site
> my stylesheet file is utilized:
>
> Building tree for all the packages and classes...
> Generating
>
> c:/ws/SofaCommonsMvn/target/site/apidocs\com/fsb/commons/configuration/\SofaConfiguration.html...
> ...
> Copying file c:\ws\SofaCommonsMvn\src\main\javadoc\stylesheet.css to
> file c:\ws\SofaCommonsMvn\target\site\apidocs\stylesheet.css...
> ...
> Building index for all the packages and classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
> Building index for all classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
>
> ----------------------
> If I then invoke:
> rm -rf target/site/apidocs ; mvn javadoc:javadoc
> my stylesheet is NOT utilized:
>
> Building tree for all the packages and classes...
> ...
> Building index for all the packages and classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
> Building index for all classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\stylesheet.css...
>
>
> Thoughts? Am I using these goals incorrectly?
>
>
> J. Thomas Halliley
> IT Architecture & Infrastructure Team
> Flagstar Bank
>
>
>
> This e-mail may contain data that is confidential, proprietary or
> non-public personal information, as that term is defined in the
> Gramm-Leach-Bliley Act (collectively, Confidential Information).
> The Confidential Information is disclosed conditioned upon your
> agreement that you will treat it confidentially and in accordance
> with applicable law, ensure that such data isn't used or disclosed
> except for the limited purpose for which it's being provided and
> will notify and cooperate with us regarding any requested or
> unauthorized disclosure or use of any Confidential Information.
> By accepting and reviewing the Confidential information, you agree
> to indemnify us against any losses or expenses, including
> attorney's fees that we may incur as a result of any unauthorized
> use or disclosure of this data due to your acts or omissions. If a
> party other than the intended recipient receives this e-mail, he or
> she is requested to instantly notify us of the erroneous delivery
> and return to us all data so delivered.
Re: maven-javadoc-plugin and custom stylesheet
Posted by Nick Stolwijk <ni...@gmail.com>.
The reporting section is only used during the execution of the site
lifecycle. The build/plugins is used during the normal lifecycle and goal
invocation. However, the configuration specified in build/plugins is also
inherited by the site lifecycle. There are a few Jira issues about this, but
in short this is how it works. You should provide the plugin configuration
inside the build/plugins sections to make it work.
Hth,
Nick Stolwijk
~Java Developer~
Iprofs BV.
Claus Sluterweg 125
2012 WS Haarlem
www.iprofs.nl
On Tue, Aug 19, 2008 at 11:11 PM, <J....@flagstar.com> wrote:
> I am having difficulties getting the maven-javadoc-plugin to utilize my
> custom stylesheet.
> (I am new to Maven)
>
> In pom.xml, I have:
>
> <project>
> ...
> <reporting>
> <plugins>
> <plugin>
> <groupId>org.apache.maven.plugins</groupId>
> <artifactId>maven-javadoc-plugin</artifactId>
> <reportSets>
> <reportSet>
> <id>html</id>
> <configuration>
>
> <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
> <overview>${basedir}/src/main/javadoc/overview.html</overview>
> ...
> </configuration>
> </reportSet>
> </reportSets>
> </plugins>
> </reporting>
> ...
> </project>
>
> ----------------------
> If I invoke
> mvn clean site
> my stylesheet file is utilized:
>
> Building tree for all the packages and classes...
> Generating
>
> c:/ws/SofaCommonsMvn/target/site/apidocs\com/fsb/commons/configuration/\SofaConfiguration.html...
> ...
> Copying file c:\ws\SofaCommonsMvn\src\main\javadoc\stylesheet.css to
> file c:\ws\SofaCommonsMvn\target\site\apidocs\stylesheet.css...
> ...
> Building index for all the packages and classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
> Building index for all classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
>
> ----------------------
> If I then invoke:
> rm -rf target/site/apidocs ; mvn javadoc:javadoc
> my stylesheet is NOT utilized:
>
> Building tree for all the packages and classes...
> ...
> Building index for all the packages and classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-tree.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index-all.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\deprecated-list.html...
> Building index for all classes...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-frame.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\allclasses-noframe.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\index.html...
> Generating
> c:/ws/SofaCommonsMvn/target/site/apidocs\overview-summary.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\help-doc.html...
> Generating c:/ws/SofaCommonsMvn/target/site/apidocs\stylesheet.css...
>
>
> Thoughts? Am I using these goals incorrectly?
>
>
> J. Thomas Halliley
> IT Architecture & Infrastructure Team
> Flagstar Bank
>
>
>
> This e-mail may contain data that is confidential, proprietary or
> non-public personal information, as that term is defined in the
> Gramm-Leach-Bliley Act (collectively, Confidential Information).
> The Confidential Information is disclosed conditioned upon your
> agreement that you will treat it confidentially and in accordance
> with applicable law, ensure that such data isn't used or disclosed
> except for the limited purpose for which it's being provided and
> will notify and cooperate with us regarding any requested or
> unauthorized disclosure or use of any Confidential Information.
> By accepting and reviewing the Confidential information, you agree
> to indemnify us against any losses or expenses, including
> attorney's fees that we may incur as a result of any unauthorized
> use or disclosure of this data due to your acts or omissions. If a
> party other than the intended recipient receives this e-mail, he or
> she is requested to instantly notify us of the erroneous delivery
> and return to us all data so delivered.