[
https://issues.apache.org/jira/browse/AVRO-3239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17457911#comment-17457911
]
ASF subversion and git services commented on AVRO-3239:
-------------------------------------------------------
Commit c7aaa7f078380ac6b16de51223f2fc52f815a7b2 in avro's branch
refs/heads/branch-1.11 from Oscar Westra van Holthe - Kind
[ https://gitbox.apache.org/repos/asf?p=avro.git;h=c7aaa7f ]
AVRO-3239: IDL parsing silently ignores dangling documentation comments (#1377)
* AVRO-3239: Add warnings for ignored doc comments
* AVRO-3239: Add mock Maven Log implementation
* AVRO-3239: Log parser warnings in Maven IDL mojo
* AVRO-3239: Log parser warnings in the IDL tools
* AVRO-3239: Document new (public) parser method
* AVRO-3239: Undo merge error and fix build
* AVRO-3239: Extract helper class for doc comments
The helper class allows better testing of and documentation for handling
doc comments. The .avpr changes all dedented comments.
* AVRO-3239: Add missing license
* AVRO-3239: Fix documentation comment
* AVRO-3239: Fix tests
* AVRO-3239: Apply review comments
> 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
> 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)
