You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by xt...@apache.org on 2023/08/02 07:43:54 UTC
[flink] 01/02: [FLINK-32559] Do not generate config option docs for Deprecated / ExcludeFromDocumentation classes.
This is an automated email from the ASF dual-hosted git repository.
xtsong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit d012b8c981bccb178827a06627a08c21ef6ee380
Author: Xintong Song <to...@gmail.com>
AuthorDate: Wed Aug 2 09:43:21 2023 +0800
[FLINK-32559] Do not generate config option docs for Deprecated / ExcludeFromDocumentation classes.
---
.../org/apache/flink/docs/util/ConfigurationOptionLocator.java | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/flink-docs/src/main/java/org/apache/flink/docs/util/ConfigurationOptionLocator.java b/flink-docs/src/main/java/org/apache/flink/docs/util/ConfigurationOptionLocator.java
index 54c9666524c..81f5713d055 100644
--- a/flink-docs/src/main/java/org/apache/flink/docs/util/ConfigurationOptionLocator.java
+++ b/flink-docs/src/main/java/org/apache/flink/docs/util/ConfigurationOptionLocator.java
@@ -19,6 +19,7 @@
package org.apache.flink.docs.util;
import org.apache.flink.annotation.VisibleForTesting;
+import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.util.function.BiConsumerWithException;
@@ -161,7 +162,9 @@ public class ConfigurationOptionLocator {
if (!EXCLUSIONS.contains(className)) {
Class<?> optionsClass = Class.forName(className);
- optionClasses.add(optionsClass);
+ if (shouldBeDocumented(optionsClass)) {
+ optionClasses.add(optionsClass);
+ }
}
}
}
@@ -169,6 +172,11 @@ public class ConfigurationOptionLocator {
return optionClasses;
}
+ private static boolean shouldBeDocumented(Class<?> clazz) {
+ return clazz.getAnnotation(Deprecated.class) == null
+ && clazz.getAnnotation(Documentation.ExcludeFromDocumentation.class) == null;
+ }
+
@VisibleForTesting
public static List<OptionWithMetaInfo> extractConfigOptions(Class<?> clazz) {
try {