[jira] [Commented] (AVRO-3294) IDL parsing allows doc comments in strange places

["Oscar Westra van Holthe - Kind (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AVRO-3294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17472004#comment-17472004 ] 

Oscar Westra van Holthe - Kind commented on AVRO-3294:
------------------------------------------------------

The current implementation of the IDL uses special tokens for doc comments, and passes them via a special call to {{DocCommentHelper}} (this was a similar call in the {{Idl}} class in the past). The PR does not change this due to backwards compatibility.

Given what this does for the calls to {{DocCommentHelper}}, it demonstrates that this solution is not really tenable for the future. After users have had time to adjust, we should break parsing on misplaced documentation comments (regular single-line / multi-line comments will remain to be supported anywhere).

> IDL parsing allows doc comments in strange places
> -------------------------------------------------
>
>                 Key: AVRO-3294
>                 URL: https://issues.apache.org/jira/browse/AVRO-3294
>             Project: Apache Avro
>          Issue Type: Improvement
>            Reporter: Oscar Westra van Holthe - Kind
>            Priority: Minor
>              Labels: pull-request-available
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
> As demonstrated by the current test case {{TestIdl#testDocCommentsAndWarnings}} (and the files {{comments.avdl}} & {{comments.avpr}}), doc comments are not handled according to spec.
> Goal: use doc comments that are placed according to spec, and generate warnings for all misplaced doc comments.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)