FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

When generate doc, ignore the hidden parameters. by horizonzy · Pull Request #16298 · apache/pulsar · GitHub

/ pulsar Public

When generate doc, ignore the hidden parameters. #16298

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

Merged
Anonymitaet merged 3 commits into from
Jul 1, 2022
Conversation 11 Commits 3 Checks 0 Files changed
Merged

When generate doc, ignore the hidden parameters. #16298

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
454be55
when generate doc, ignore the hidden parameters.
horizonzy Jun 30, 2022
451405c
cover more case.
horizonzy Jun 30, 2022
93cafcc
ignore the deprecated.
horizonzy Jun 30, 2022
File filter

Filter by extension

Filter by extension .java  (3) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 4 additions & 4 deletions pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ private void generateDocument(StringBuilder sb, String module, JCommander obj) {
sb.append("|Flag|Description|Default|\n");
sb.append("|---|---|---|\n");
}
options.forEach((option) ->
sb.append("| `").append(option.getNames())
.append("` | ").append(option.getDescription().replace("\n", " "))
.append("|").append(option.getDefault()).append("|\n")
options.stream().filter(ele -> !ele.getParameterAnnotation().hidden()).forEach((option) ->
sb.append("| `").append(option.getNames())
.append("` | ").append(option.getDescription().replace("\n", " "))
.append("|").append(option.getDefault()).append("|\n")
);
});
System.out.println(sb.toString());
Expand Down
2 changes: 1 addition & 1 deletion pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ protected String generateDocument(String module, JCommander parentCmd) {
sb.append("|Flag|Description|Default|\n");
sb.append("|---|---|---|\n");
List<ParameterDescription> options = cmd.getParameters();
options.forEach((option) ->
options.stream().filter(ele -> !ele.getParameterAnnotation().hidden()).forEach((option) ->
sb.append("| `").append(option.getNames())
.append("` | ").append(option.getDescription().replace("\n", " "))
.append("|").append(option.getDefault()).append("|\n")
Expand Down
2 changes: 1 addition & 1 deletion pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ private static String generateDocument(String module, JCommander parentCmd) {
sb.append("|Flag|Description|Default|\n");
sb.append("|---|---|---|\n");
List<ParameterDescription> options = cmd.getParameters();
options.forEach((option) ->
options.stream().filter(ele -> !ele.getParameterAnnotation().hidden()).forEach((option) ->
sb.append("| `").append(option.getNames())
.append("` | ").append(option.getDescription().replace("\n", " "))
.append("|").append(option.getDefault()).append("|\n")
Expand Down
Back | FazBrowse Home | New Git URL