[GitHub] [incubator-druid] leventov opened a new issue #4861: Declarative configs, parse Druid options docs from code

[GitBox <gi...@apache.org>]

leventov opened a new issue #4861: Declarative configs, parse Druid options docs from code
URL: https://github.com/apache/incubator-druid/issues/4861
 
 
   To understand the meaning of some option in code, I sometimes need to find this option in docs and read it's description there. Because there are no docs in code.
   
   Suggestions:
    1. Set config prefixes declaratively, e. g.
   ```java
      @ConfigPrefix("druid.segmentCache") class SegmentLoaderConfig {}
   ```
   
    2. Move descriptions of options from doc pages to Javadocs of corresponding fields in config classes. We may also add custom tags like `@defaultValue`, `@required`.
   3. In docs markdown, we write something like `[[optionDescriptions io.druid.segment.loading.SegmentLoaderConfig]]`, it finds corresponding class in the code using DocLet or something, parses fields with `@JsonProperty` annotations, their javadocs, etc. and builds an html table from all of that. We may also parse default values from the code itself.

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org