You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@groovy.apache.org by "Paul King (Jira)" <ji...@apache.org> on 2026/04/21 07:14:00 UTC

[jira] [Resolved] (GROOVY-11945) recognise @apiNote, @implSpec, @implNote block tags in groovydoc

     [ https://issues.apache.org/jira/browse/GROOVY-11945?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Paul King resolved GROOVY-11945.
--------------------------------
    Fix Version/s: 6.0.0-alpha-1
       Resolution: Fixed

> recognise @apiNote, @implSpec, @implNote block tags in groovydoc
> ----------------------------------------------------------------
>
>                 Key: GROOVY-11945
>                 URL: https://issues.apache.org/jira/browse/GROOVY-11945
>             Project: Groovy
>          Issue Type: Improvement
>            Reporter: Paul King
>            Assignee: Paul King
>            Priority: Major
>             Fix For: 6.0.0-alpha-1
>
>
> Javadoc has supported three additional block tags since JEP 172: @apiNote (guidance for callers), @implSpec (contract that overriders must preserve), and @implNote (non-contract implementation detail). Groovydoc does not recognise any of
>   them. They currently fall through the unknown-tag path and render inline at source position as a plain generic block with the raw tag name as its label, e.g. "implNote:" instead of "Implementation Note:", and they appear wherever the     
>   author wrote them rather than being collated with @param / @return in the method's tag section.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)