[pulsar] branch master updated: Generate documentation of Client automatically (#11419)

[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 e48a2e9  Generate documentation of Client automatically (#11419)
e48a2e9 is described below

commit e48a2e9ecba31ac57b0b4dc2473c7d8557d99a81
Author: feynmanlin <feynman...@tencent.com>
AuthorDate: Mon Jul 26 10:18:13 2021 +0800

    Generate documentation of Client automatically (#11419)
---
 .../main/java/org/apache/pulsar/utils/CmdGenerateDocumentation.java | 4 ++++
 pulsar-broker/src/test/java/org/apache/pulsar/utils/CmdTest.java    | 6 +++++-
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git 
a/pulsar-broker/src/main/java/org/apache/pulsar/utils/CmdGenerateDocumentation.java
 
b/pulsar-broker/src/main/java/org/apache/pulsar/utils/CmdGenerateDocumentation.java
index 25c7318..2181ab8 100644
--- 
a/pulsar-broker/src/main/java/org/apache/pulsar/utils/CmdGenerateDocumentation.java
+++ 
b/pulsar-broker/src/main/java/org/apache/pulsar/utils/CmdGenerateDocumentation.java
@@ -23,6 +23,7 @@ import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.pulsar.broker.BaseGenerateDocumentation;
 import org.apache.pulsar.broker.ServiceConfiguration;
+import org.apache.pulsar.client.impl.conf.ClientConfigurationData;
 import org.apache.pulsar.websocket.service.WebSocketProxyConfiguration;
 
 @Data
@@ -39,6 +40,9 @@ public class CmdGenerateDocumentation extends 
BaseGenerateDocumentation {
         if (WebSocketProxyConfiguration.class.getName().equals(className)) {
             return generateDocByFieldContext(className, "WebSocket", sb);
         }
+        if (ClientConfigurationData.class.getName().equals(className)) {
+            return generateDocByApiModelProperty(className, "Client", sb);
+        }
         return "Class [" + className + "] not found";
     }
 
diff --git a/pulsar-broker/src/test/java/org/apache/pulsar/utils/CmdTest.java 
b/pulsar-broker/src/test/java/org/apache/pulsar/utils/CmdTest.java
index 9a49da9..07426ee 100644
--- a/pulsar-broker/src/test/java/org/apache/pulsar/utils/CmdTest.java
+++ b/pulsar-broker/src/test/java/org/apache/pulsar/utils/CmdTest.java
@@ -22,7 +22,6 @@ import static org.testng.Assert.assertTrue;
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.lang.reflect.Field;
-import org.apache.pulsar.broker.ServiceConfiguration;
 import org.apache.pulsar.common.configuration.FieldContext;
 import org.testng.annotations.Test;
 
@@ -39,6 +38,11 @@ public class CmdTest {
         
generateDoc("org.apache.pulsar.websocket.service.WebSocketProxyConfiguration");
     }
 
+    @Test
+    public void cmdParserClientTest() throws Exception {
+        
generateDoc("org.apache.pulsar.client.impl.conf.ClientConfigurationData");
+    }
+
     private void generateDoc(String clazz) throws Exception {
         PrintStream oldStream = System.out;
         try (ByteArrayOutputStream baoStream = new ByteArrayOutputStream(2048);