'JavaDoc: specify compatibility up to a specific version?
Similarly to how I can specify the minimum compatible Java version using the @since
tag, I'd like to specify in my JavaDoc the maximum compatible version (e.i. indicate that my class is only compatible with versions prior to Java 9).
I've seen @version
used to specify the compiler version, but a lot of Java code is forwards compatible so I'm not sure if this would work for specifying a bound. I've also seen people use @deprecated
with a message saying "removed in Java 9." I don't want to deprecate the class because for the time being it is only intended to be used with Java 8.
Obviously, I can simply leave a note in the JavaDoc comment itself. But my curiosity got the better of me. Is there a JavaDoc tag I can use for this purpose?
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
Solution | Source |
---|