Airblader opened a new pull request #16515:
URL: https://github.com/apache/flink/pull/16515
## What is the purpose of the change
This introduces a new interface which can be implemented for enums which are
used in (enum-based) `ConfigOption`s. It allows providing documentation about
the individual values. This is then used in `ConfigOptionsDocGenerator`: the
list of available values is moved from "Type" to "Description", and if the
interface is implemented, the provided documentation is added to each listed
value.
One note: `DescribedEnum#getDescription` cannot return an actual
`Description` because those cannot be nested into a list, only inline elements
can.
This PR also goes through the enum options currently covered by the docs
generator and applies this change there. In #16482 this will be used to convert
some string-based connector options into enum-based ones as well.
## Brief change log
* `DescribedEnum` interface for enums used in options
* `ConfigOptionsDocGenerator` to make use of this new interface
* Cleaned up some options to use this new feature
## Verifying this change
This change added tests and can be verified as follows:
* `ConfigOptionsDocGeneratorTest`
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: yes
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? JavaDocs
--
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]
