opwvhk commented on a change in pull request #1407:
URL: https://github.com/apache/avro/pull/1407#discussion_r755399216
##########
File path: doc/src/content/xdocs/idl.xml
##########
@@ -429,50 +429,62 @@ record MyRecord {
<p>Some annotations like those listed above are handled
specially. All other annotations are added as properties to
the protocol, message, schema or field.</p>
+ <p>Note that for named types, annotations should be added to
+ the type definition; they cannot be added to the type references.</p>
</section>
</section>
<section id="example">
<title>Complete Example</title>
- <p>The following is a complete example of a Avro IDL file that shows
most of the above features:</p>
+ <p>The following is an example of an Avro IDL file that shows most of
the above features:</p>
<source>
+/*
+* Header with license information.
+*/
+
/**
* An example protocol in Avro IDL
*/
@namespace("org.apache.avro.test")
protocol Simple {
-
+ /** Documentation for the enum type Kind */
Review comment:
The parser supports doc comments, but only trims them; any * prefixes on
lines are kept.
I intend to improve upon this in a PR that'll also ignore doc comments
halfway declarations. But I need PR #1377 for this, as I want the tools to emit
warnings when this happens.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
