[pulsar] branch master updated: When generate doc, ignore the hidden parameters. (#16298)

[liuyu]

This is an automated email from the ASF dual-hosted git repository.

liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 8b5bdb35932 When generate doc, ignore the hidden parameters. (#16298)
8b5bdb35932 is described below

commit 8b5bdb35932c3be9c020bca355c7557ae341008a
Author: Yan Zhao <horizo...@apache.org>
AuthorDate: Fri Jul 1 16:59:22 2022 +0800

    When generate doc, ignore the hidden parameters. (#16298)
---
 .../java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java     | 8 ++++----
 .../org/apache/pulsar/client/cli/CmdGenerateDocumentation.java    | 2 +-
 .../org/apache/pulsar/testclient/CmdGenerateDocumentation.java    | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git 
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
 
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
index 7d24321342e..d879f771d4f 100644
--- 
a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
+++ 
b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java
@@ -121,10 +121,10 @@ public class CmdGenerateDocument extends CmdBase {
                     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());
diff --git 
a/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
 
b/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
index 2c5be0e487a..08dbd52331d 100644
--- 
a/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
+++ 
b/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java
@@ -78,7 +78,7 @@ public class CmdGenerateDocumentation {
         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")
diff --git 
a/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
 
b/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
index 9abeb35ad06..8e1b3f54909 100644
--- 
a/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
+++ 
b/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java
@@ -113,7 +113,7 @@ public class CmdGenerateDocumentation {
         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")