yarn icon indicating copy to clipboard operation
yarn copied to clipboard

Documentation should dynamically reference constant values

Open haykam821 opened this issue 4 years ago • 1 comments

As per the Documentation Comment Specification for the Standard Doclet, the {@value} inline tag can be used to dynamically reference constant values.

Since constants are now available in Minecraft 1.17, they can be used in documentation.

haykam821 avatar Jun 11 '21 15:06 haykam821

Hmm, what are we supposed to do? Fyi for all constants, javadoc will generate a link to their corresponding value in the constant values page. So if a specific value isn't badly needed, javadoc html readers can always go to the constant value page while code readers can just read the initializer code from the decompiler.

liach avatar Jun 21 '21 01:06 liach