This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new a45bd489 [MJAVADOC-685] No longer document deprecated parameter
stylesheet (#165)
a45bd489 is described below
commit a45bd489d4b3c454c11dfd09dac9cb434ef37602
Author: Konrad Windszus <k...@apache.org>
AuthorDate: Thu Sep 29 19:04:40 2022 +0200
[MJAVADOC-685] No longer document deprecated parameter stylesheet (#165)
Document 'addStylesheets' as recommended way of configuring stylesheets
---
.../apt/examples/stylesheet-configuration.apt.vm | 34 +++-------------------
1 file changed, 4 insertions(+), 30 deletions(-)
diff --git a/src/site/apt/examples/stylesheet-configuration.apt.vm
b/src/site/apt/examples/stylesheet-configuration.apt.vm
index e38d347c..61e73326 100644
--- a/src/site/apt/examples/stylesheet-configuration.apt.vm
+++ b/src/site/apt/examples/stylesheet-configuration.apt.vm
@@ -29,37 +29,11 @@
Configuring Stylesheets
- If no custom stylesheet is specified in the
{{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} parameter,
- the {{{../javadoc-mojo.html#stylesheet}\<stylesheet/\>}} parameter will
indicate
- which stylesheet will be used -- the stylesheet included in the maven javadoc
plugin or the default stylesheet used by
- the javadoc tool. <<maven>> value indicates the maven javadoc plugin
stylesheet, while <<java>> value indicates the
- default javadoc tool stylesheet. The default is <<java>> value if not
specified.
+ To apply minor styling adjustments it is recommended to just configure
additional stylesheets (in addition to the javadoc generated CSS) via
+ {{{../javadoc-mojo.html#addstylesheets}\<addStylesheets/\>}} (supported since
3.3.0).
-+-----+
-<project>
- ...
- <reporting> (or <build>)
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <stylesheet>maven</stylesheet>
- ...
- </configuration>
- </plugin>
- </plugins>
- ...
- </reporting> (or </build>)
- ...
-</project>
-+-----+
-
-Configuring Stylesheets File
-
- If a custom {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}}
parameter is specified, you will be able to
- use it:
+ If a custom {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}}
parameter is specified the javadoc generated CSS is completely replaced with
+ just the given CSS:
* if {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} is a given
file, you could use an absolute or a
relative path, for instance:
