[GitHub] [accumulo] ctubbsii commented on issue #1117: Add since information to properties

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

ctubbsii commented on issue #1117:
URL: https://github.com/apache/accumulo/issues/1117#issuecomment-872578979


   @foster33 Yes, this would still be a nice addition. Adding both "since" and "deprecated since", and also "replaced by", if relevant, information to the generated docs at https://accumulo.apache.org/docs/2.x/configuration/server-properties would be great. The code that generates the Markdown for that page is in core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java
   
   For "deprecated since" you could use the `@Deprecated(since = "1.6.4")` annotation information. You can pull the "replaced by" information from our own `@ReplacedBy` annotation. You'll probably have to create some kind of `@Since` annotation, but you may wish to avoid using that name, so it's not confused with the built-in javadoc `@since` tag. Perhaps `@AvailableSince`?
   
   A quick Google search and I found a tutorial about accessing annotation parameters that could be useful at https://nadundesilva.medium.com/reading-annotations-at-run-time-using-the-java-reflections-api-ce175ba43b2
   
   Adding these in an automated way using these annotations could help us remove the same, redundant information from the description fields that we had been manually adding.
   


-- 
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: notifications-unsubscribe@accumulo.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org