Skip to content

Commit

Permalink
8332080: Update troff man page for javadoc
Browse files Browse the repository at this point in the history
Reviewed-by: jjg
  • Loading branch information
hns committed May 13, 2024
1 parent 391bbbc commit 1484153
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions src/jdk.javadoc/share/man/javadoc.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion test/langtools/jdk/javadoc/tool/CheckManPageOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public static void main(String... args) throws Exception {

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]);
Expand Down

0 comments on commit 1484153

Please sign in to comment.