Skip to content

Commit a45bd48

Browse files
authored
[MJAVADOC-685] No longer document deprecated parameter stylesheet (#165)
Document 'addStylesheets' as recommended way of configuring stylesheets
1 parent 8b58932 commit a45bd48

File tree

1 file changed

+4
-30
lines changed

1 file changed

+4
-30
lines changed

src/site/apt/examples/stylesheet-configuration.apt.vm

+4-30
Original file line numberDiff line numberDiff line change
@@ -29,37 +29,11 @@
2929

3030
Configuring Stylesheets
3131

32-
If no custom stylesheet is specified in the {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} parameter,
33-
the {{{../javadoc-mojo.html#stylesheet}\<stylesheet/\>}} parameter will indicate
34-
which stylesheet will be used -- the stylesheet included in the maven javadoc plugin or the default stylesheet used by
35-
the javadoc tool. <<maven>> value indicates the maven javadoc plugin stylesheet, while <<java>> value indicates the
36-
default javadoc tool stylesheet. The default is <<java>> value if not specified.
32+
To apply minor styling adjustments it is recommended to just configure additional stylesheets (in addition to the javadoc generated CSS) via
33+
{{{../javadoc-mojo.html#addstylesheets}\<addStylesheets/\>}} (supported since 3.3.0).
3734

38-
+-----+
39-
<project>
40-
...
41-
<reporting> (or <build>)
42-
<plugins>
43-
<plugin>
44-
<groupId>org.apache.maven.plugins</groupId>
45-
<artifactId>maven-javadoc-plugin</artifactId>
46-
<version>${project.version}</version>
47-
<configuration>
48-
<stylesheet>maven</stylesheet>
49-
...
50-
</configuration>
51-
</plugin>
52-
</plugins>
53-
...
54-
</reporting> (or </build>)
55-
...
56-
</project>
57-
+-----+
58-
59-
Configuring Stylesheets File
60-
61-
If a custom {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} parameter is specified, you will be able to
62-
use it:
35+
If a custom {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} parameter is specified the javadoc generated CSS is completely replaced with
36+
just the given CSS:
6337

6438
* if {{{../javadoc-mojo.html#stylesheetfile}\<stylesheetfile/\>}} is a given file, you could use an absolute or a
6539
relative path, for instance:

0 commit comments

Comments
 (0)