Airblader commented on a change in pull request #16515: URL: https://github.com/apache/flink/pull/16515#discussion_r671347200
########## File path: flink-core/src/main/java/org/apache/flink/configuration/DescribedEnum.java ########## @@ -0,0 +1,47 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.configuration; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.configuration.description.Description; +import org.apache.flink.configuration.description.InlineElement; +import org.apache.flink.configuration.description.TextElement; + +import java.util.List; + +/** + * Describe enum constants used in {@link ConfigOption}s. + * + * <p>For enums used as config options, this interface can be implemented to provide a {@link + * Description} for each enum constant. This will be used when generating documentation for config + * options to include a list of available values alongside their respective descriptions. + * + * <p>More precisely, only a list of {@link InlineElement}s can be returned as block elements cannot + * be nested into a list. + */ +@PublicEvolving +public interface DescribedEnum { + + /** + * Returns the description for the enum constant. + * + * <p>Typically, this will return a simple, single {@link TextElement}. + */ + List<InlineElement> getDescription(); Review comment: Yeah, if you want to add links or code, you'd need to use multiple inline elements. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
