You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "Chesnay Schepler (Jira)" <ji...@apache.org> on 2022/06/07 08:39:00 UTC

[jira] [Commented] (FLINK-27920) Documented enums constant support ExcludeFromDocumentation annotation

    [ https://issues.apache.org/jira/browse/FLINK-27920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17550877#comment-17550877 ] 

Chesnay Schepler commented on FLINK-27920:
------------------------------------------

Do you have an example for such an enum?

> Documented enums constant support ExcludeFromDocumentation annotation
> ---------------------------------------------------------------------
>
>                 Key: FLINK-27920
>                 URL: https://issues.apache.org/jira/browse/FLINK-27920
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Weijie Guo
>            Priority: Major
>              Labels: pull-request-available
>
> if a config option has @ExcludeFromDocumentation annotation, it will not appear in the document. But for an enumeration type, sometimes we only want some of it's constant values not to appear in the document, this ticket solves this problem.



--
This message was sent by Atlassian Jira
(v8.20.7#820007)