[
https://issues.apache.org/jira/browse/AVRO-3239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17432095#comment-17432095
]
Oscar Westra van Holthe - Kind edited comment on AVRO-3239 at 10/20/21, 8:52 PM:
---------------------------------------------------------------------------------
Attached two files, part of a test case I'm working on:
* [^comments.avdl] contains an IDL file with many dangling comments
* [^comments.avpr] contains the compiled version, where only some comments are
retained
The compiler does not emit any warnings, but does throw away most (should
probably be all) dangling comments.
was (Author: opwvhk):
Attached two files, part of a test case I'm working on:
* [^comments.avdl] contains an IDL file with many dangling comments
* [^comments.avpr] contains the compiled version, where only some comments are
retained
The compiler does not emit any warnings, but does throw away most (should
probably be all) dangling comments.
> IDL parsing silently ignores dan going documentation comments
> -------------------------------------------------------------
>
> Key: AVRO-3239
> URL: https://issues.apache.org/jira/browse/AVRO-3239
> Project: Apache Avro
> Issue Type: Improvement
> Components: java, tools
> Affects Versions: 1.8.2, 1.9.2, 1.10.2
> Reporter: Oscar Westra van Holthe - Kind
> Priority: Minor
> Attachments: comments.avdl, comments.avpr
>
>
> When parsing IDL, only the last documentation comment for a declaration is
> used.
> Any previous documentation comments are silently ignored.
> Proposed fix: while keeping the exact same parsing results, emit warnings for
> each documentation comment that is ignored.
> Additional suggestion: mention that a common cause for such a warning is
> using a documentation comment instead of a multiline comment.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
