[ https://issues.apache.org/jira/browse/AVRO-3239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17432479#comment-17432479 ]
Oscar Westra van Holthe - Kind commented on AVRO-3239: ------------------------------------------------------ Aside from informing the user when documentation comments are ignored, ideas behind this is to set a basis to improve documentation comment handling. The attachment [^comments.avdl] shows this: some documentation comments attach themselves to unexpected definitions. > 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, tools > Affects Versions: 1.8.2, 1.9.2, 1.10.2 > Reporter: Oscar Westra van Holthe - Kind > Priority: Minor > Labels: pull-request-available > Attachments: comments.avdl, comments.avpr > > Time Spent: 10m > 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.3.4#803005)