Skip to content

8273001: Improve the doclet.usage.tagletpath option description #6745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

8273001: Improve the doclet.usage.tagletpath option description #6745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
885da62
Initial commit
pavelrappo Dec 7, 2021
8465fd3
Rephrase taglet.description as per feedback
pavelrappo Dec 8, 2021
a031dee
Merge branch 'openjdk:master' into 8273001
pavelrappo Jan 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions ...doc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,16 +547,19 @@ doclet.usage.tag.description=\
Specify single argument custom tags

doclet.usage.taglet.description=\
The fully qualified name of Taglet to register
The fully qualified name of the taglet to register

doclet.usage.tagletpath.parameters=\
<path>

doclet.usage.tagletpath.description=\
The path to Taglets
The path to custom taglets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest the general form: The search path for ... so The search path for custom taglets

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest the general form: The search path for ... so The search path for custom taglets

Improved suggestion: The search path for locating ...

Copy link
Member Author

@pavelrappo pavelrappo Dec 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... I think that we should be consistent and rely on the JDK tools vocabulary more. I mean, if it's search path, why would we also use locating? Looking at help output for javac and jshell, they don't seem to use search path. Their man pages do, but their help output does not.


doclet.usage.snippet-path.parameters=\
<path>

doclet.usage.snippet-path.description=\
The path for external snippets
The path to external snippets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest: The search path for external snippets


doclet.usage.charset.parameters=\
<charset>
Expand Down
8 changes: 4 additions & 4 deletions src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/BaseOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,13 +293,13 @@ public enum ModularityMismatchPolicy {

/**
* Argument for command-line option {@code -tagletpath}.
* The path to Taglets
* The path to custom taglets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Less important (since it's an internal comment) but see suggestion for help string.

*/
private String tagletPath = null;

/**
* Argument for command-line option {@code --snippet-path}.
* The path for external snippets.
* The path to external snippets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See similar comments

*/
private String snippetPath = null;

Expand Down Expand Up @@ -1007,15 +1007,15 @@ public boolean summarizeOverriddenMethods() {

/**
* Argument for command-line option {@code -tagletpath}.
* The path to Taglets
* The path to custom taglets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See similar comments

*/
public String tagletPath() {
return tagletPath;
}

/**
* Argument for command-line option {@code --snippet-path}.
* The path for external snippets.
* The path to external snippets.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See similar comments

*/
public String snippetPath() {
return snippetPath;
Expand Down