[Java][QUESTION] Placeholder JavaDoc 'deprecated' description?

[Chrimle]

Whenever generating DTOs in Java, the generated JavaDocs will include @deprecated when it's marked as deprecated, like so:

/**
 * Example of a deprecated Enum
 *
 * @deprecated
 */
@Deprecated
public enum DeprecatedExampleEnum {

However, it will result in compilation warnings:

[EmptyBlockTag] A block tag (@param, @return, @throws, @deprecated) has an empty description. Block tags without descriptions don't add much value for future readers of the code; consider removing the tag entirely or adding a description. (see https://google.github.io/styleguide/javaguide.html#s7.1.3-javadoc-block-tags)

Question

Should there be some placeholder value? Unless... is there some vendor-extension to provide the deprecation details?

Simply adding a dot will resolve the warnings. Or perhaps "details missing". Thoughts?

[Picazsoo]

I guess for starters just adding "marked in openapi spec" or something similar would be good enough. Or "See the spec for details"

[wing328]

Or simply just put down "Deprecated" or "This has been deprecated"

[leuasseurfarrelds247-arch]

https://idp.genai.h2o.ai/u/login?state=hKFo2SB3ZF9kMnJCUDdmbnh5OE10c2F5OTdQRng1MDEyOTVXVqFur3VuaXZlcnNhbC1sb2dpbqN0aWTZIFcxX1BKOGJHVXdRWFZuVUFpWGI2UUp3a3diVUFWRHBvo2NpZNkga21vRWVpeHQyZVFycFhWeDFjV2lxOW9WaXBMMWpPZ04

[Chrimle]

I guess for starters just adding "marked in openapi spec" or something similar would be good enough. Or "See the spec for details"

I would assume that details about the deprecation would be part of the general description, hence, it would already be part of same JavaDoc (above). So, that's why I'm leaning towards "as small placeholder as possible", since it will otherwise be overly verbose, and even opinionated.

/**
 * Example of a deprecated Enum
 *
 * @deprecated .
 */

or

/**
 * Example of a deprecated Enum
 *
 * @deprecated Deprecated.
 */

or

/**
 * Example of a deprecated Enum
 *
 * @deprecated See above.
 */

or

/**
 * Example of a deprecated Enum
 *
 * @deprecated Details missing.
 */