stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8332080: Update troff man page for javadoc

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Hannes Wallnöfer 2024-05-13 09:48:23 +00:00
parent 391bbbc7d0
commit 1484153c1a
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/jdk.javadoc/share/man/javadoc.1
View File

@ -108,8 +108,8 @@ declaration, they will be ignored.
To check for any extra or misplaced documentation comments, compile your
source code with the \f[V]javac\f[R] option \f[V]-Xlint\f[R], or more
specifically, \f[V]-Xlint:dangling-doc-comments\f[R].
Within a source file, you may use suppress any warnings generated by
these options by using
Within a source file, you may suppress any warnings generated by these
options by using
\f[V]\[at]SuppressWarnings(\[dq]dangling-doc-comments\[dq])\f[R] on a
suitable enclosing declaration.
.SS Conformance
@ -920,6 +920,11 @@ throughout the rest of the document.
This is useful when your source code contains no deprecated APIs, and
you want to make the navigation bar cleaner.
.TP
\f[V]--no-fonts\f[R]
Prevents inclusion of font files in the generated documentation.
This can be useful if the documentation uses a custom stylesheet which
does not use the default fonts.
.TP
\f[V]-nohelp\f[R]
Omits the \f[B]HELP\f[R] link in the navigation bar at the top of each
generated page.

2
test/langtools/jdk/javadoc/tool/CheckManPageOptions.java
View File

@ -66,7 +66,7 @@ public class CheckManPageOptions {
static final PrintStream out = System.err;
List<String> MISSING_IN_MAN_PAGE = List.of("--no-fonts");
List<String> MISSING_IN_MAN_PAGE = List.of();
void run(String... args) throws Exception {
var file = args.length == 0 ? findDefaultFile() : Path.of(args[0]);