Stanislav Lukyanov created IGNITE-26938:
-------------------------------------------
Summary: Add {@value} to constant javadocs
Key: IGNITE-26938
URL: https://issues.apache.org/jira/browse/IGNITE-26938
Project: Ignite
Issue Type: Improvement
Reporter: Stanislav Lukyanov
Javadoc doesn't include constant values by default, only adding a reference to
another Javadoc page with all constants. See, for example,
`IgniteClientConfiguration#DFTL_PORT`.
This is fine for Java-to-Java linking when you actually don't care when the
constants are. But when the constant is, for example, the port that the client
will use, you do need to know it - to cross-check with the server config, setup
firewall rules, etc.
The Javadoc solution for this is to use `{@value}`. We can either mandate that
these values are included manually, or add a doclet that will automatically
include a line like the following to all Javadocs:
> <p> Value: {@ value}.
The automation seems better than enforcement. This would assume that we never
use {@value} in the Javadocs though, to avoid an awkward repetition. This needs
to be documented in the dev wiki or devnotes.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
