You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Oscar Westra van Holthe - Kind (Jira)" <ji...@apache.org> on 2021/12/07 08:25:00 UTC
[jira] [Comment Edited] (AVRO-3239) IDL parsing silently ignores dangling documentation comments
[ https://issues.apache.org/jira/browse/AVRO-3239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17454460#comment-17454460 ]
Oscar Westra van Holthe - Kind edited comment on AVRO-3239 at 12/7/21, 8:24 AM:
--------------------------------------------------------------------------------
A recent addition to this issue is a separate class to handle documentation comments. This also strips indents, as suggested by [~mgrigorov] in [PR #1407|https://github.com/apache/avro/pull/1407#discussion_r754204005].
This also allows easier testing and makes the change a bit easier to read.
was (Author: opwvhk):
A recent addition to this issue is a separate class to handle documentation comments. This also strips indents, as suggested by [~mgrigorov] in [PR #1407|https://github.com/apache/avro/pull/1407#discussion_r754204005]
> 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: 1.5h
> 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)