@PublicEvolving public interface DescribedEnum
For enums used as config options, this interface can be implemented to provide a
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.
More precisely, only an
InlineElement can be returned as block elements cannot be
nested into a list.
|Modifier and Type||Method and Description|
Returns the description for the enum constant.
If you want to include links or code blocks, use
TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.