Samuel Martin created AVRO-2253:
-----------------------------------
Summary: Documentation of java-class -related annotations
Key: AVRO-2253
URL: https://issues.apache.org/jira/browse/AVRO-2253
Project: Avro
Issue Type: Bug
Components: java, spec
Reporter: Samuel Martin
There is a lack of consistency in the documentation about the use of
@java-class (plus, its relation with avro.java.string), @java-element-class and
@java-key-class annotations
For instance, see the references to
`[@java-element-class|https://github.com/apache/avro/search?q=java-element-class&unscoped_q=java-element-class]`,
and the [mentions to the same
annotation|https://sematext.com/opensee/?tag=avro&project=Avro&t=&q=%22java-element-class%22]
and to `ELEMENT_PROP` as well (in the different classes where constants with
that name appear).
In some places, documentation talks about
[@java-element|https://avro.apache.org/docs/1.6.3/api/java/org/apache/avro/reflect/package-summary.html]
instead of @java-element-class
Even the test case that is supposed to be provided as an [example of use of
@java-element-class|https://github.com/apache/avro/search?q=java-element-class&unscoped_q=java-element-class]
indeed employs @java-class
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
