[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16298: When generate doc, ignore the hidden parameters.

[GitBox <gi...@apache.org>]

Anonymitaet commented on code in PR #16298:
URL: https://github.com/apache/pulsar/pull/16298#discussion_r911133735


##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -90,7 +90,7 @@ protected String generateDocByFieldContext(String className, String type, String
         sb.append("|---|---|---|---|---|\n");
         for (Field field : fields) {
             FieldContext fieldContext = field.getAnnotation(FieldContext.class);
-            if (fieldContext == null) {
+            if (fieldContext == null || fieldContext.deprecated()) {

Review Comment:
   @urfreespace I've discussed w/ @horizonzy, we'll use the parameter [` hidden`](https://github.com/apache/pulsar/blob/d711100dabe34f35d827cc61bc736baa53d5c32c/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java#L280) to determine whether show a flag or not (and ignore the `deprecated` parameter). I'll huddle w/ u tmr.
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org