[
https://issues.apache.org/jira/browse/AVRO-3294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17488340#comment-17488340
]
ASF subversion and git services commented on AVRO-3294:
-------------------------------------------------------
Commit 2681c1b0979fc37685d019c0db956593aa2ea5a2 in avro's branch
refs/heads/master from Oscar Westra van Holthe - Kind
[ https://gitbox.apache.org/repos/asf?p=avro.git;h=2681c1b ]
AVRO-3294: Improve IDL doc comment handling (#1453)
* AVRO-3294: Improve IDL doc comment handling
Use the previously introduced method `DocCommentHandler#clearDoc()` to
generate warnings for misplaced documentation. Also add documentation to
describe the tricky bits when using this method.
The brittleness of the solution proves that doc comments as special
tokens are a hack. However, making regular tokens out of them may break
existing `.avdl` files.
* AVRO-3294: Trigger build
> 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
> Components: java, tools
> Reporter: Oscar Westra van Holthe - Kind
> Priority: Minor
> Labels: pull-request-available
> Fix For: 1.11.1
>
> Time Spent: 40m
> 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)
