[AVRO-3239] IDL parsing silently ignores dangling documentation comments

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.8.2, 1.9.2, 1.10.2
• Fix Version/s: 1.11.1
• Component/s: java, spec, tools
• Labels: pull-request-available
• Assignee: Oscar Westra van Holthe - Kind
• Reporter: Oscar Westra van Holthe - Kind
• Created: 20/Oct/21 19:33
• Updated: 12/Dec/21 11:14
• Resolved: 12/Dec/21 11:14

Description

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.

Issue Links

• links to: GitHub Pull Request #1377