[
https://issues.apache.org/jira/browse/AVRO-3239?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ryan Skraba updated AVRO-3239:
------------------------------
Resolution: Fixed
Status: Resolved (was: Patch Available)
Cherry-picked to
[branch-1.11|https://github.com/apache/avro/commit/7e97a1084e11851a2614677dc088734758594049]
> IDL parsing silently ignores dangling documentation comments
> ------------------------------------------------------------
>
> Key: AVRO-3239
> URL: https://issues.apache.org/jira/browse/AVRO-3239
> Project: Apache Avro
> Issue Type: Improvement
> Components: java, spec, tools
> Affects Versions: 1.8.2, 1.9.2, 1.10.2
> Reporter: Oscar Westra van Holthe - Kind
> Assignee: Oscar Westra van Holthe - Kind
> Priority: Minor
> Labels: pull-request-available
> Fix For: 1.11.1
>
> Attachments: comments.avdl, comments.avpr
>
> Time Spent: 2h 40m
> Remaining Estimate: 0h
>
> 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.20.1#820001)
