Skip to content

What types of invalid links can InvalidLink detect? #5609

@TysonMN

Description

@TysonMN

The documentation for InvalidLink currently says

This error is triggered by a Javadoc @link tag that either is syntactically invalid or can’t be resolved. See javadoc documentation for an explanation of how to correctly format the contents of this tag.

There is nothing about what types of invalid links can be detected. The linked javadoc documentation mentions three types of links:

  1. Referencing a member of the current class
  2. Referencing another class in the current or imported packages
  3. Referencing an element in another package (fully qualified)

In my experience, InvalidLink can only detect invalid links of the first type. I have many broken links of the second and third types that InvalidLink is not detecting.

Is this correct?

If so, can the documentation for InvalidLink be updated to say that it can only detect invalid links of the first type?

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