Skip to content

Add support for JavaDoc tags @apiNote, @implSpec and @implNote #1796

@uhafner

Description

@uhafner

Description of the problem / feature request:

The rule InvalidTag reports false positives for JavaDoc tag @implNote.

Error message:

 [InvalidTag] Tag name `implNote` is unknown. If this is a commonly-used custom tag, please click 'not useful' and file a bug.

Feature requests: what underlying problem are you trying to solve with this feature?

Please support these tags: https://blog.codefx.org/java/new-javadoc-tags/

Bugs: what's the simplest, easiest way to reproduce this bug? Please provide a minimal example if possible.

    /**
     * Detects variations of {@code rootProject.setName($string)}, as well as the Groovy setter shorthand
     * {@code rootProject.name = $string}.
     *
     * @implNote This expression does not guarantee matching left/right quotes or parentheses. For example, it will
     * match {@code 'Name"}, even though that is not valid Groovy or Kotlin syntax. Similarly, in allowing for Groovy's
     * parentheses-optional syntax for {@code setName $string}, this pattern makes both open and close parentheses
     * optional, rather than requiring neither or both, so it will parse an open parenthesis without a matching close,
     * and vice versa.
     */
     public class Tags {}

What version of Error Prone are you using?

2.4.0

Have you found anything relevant by searching the web?

No

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions