Skip to content

Javadoc builder is more strict than the javadoc tests #3757

Closed

Description

@chingor13
  • f6b93fa fixed some documentation errors that were not caught by the javadoc tests. The tests should ensure that the full documentation site can build and not block a release
  • Update to maven-javadoc-plugin 3.0+ and set doclint configuration option

Activity

  1. added
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    priority: p2Moderately-important priority. Fix may not be included in next release.
    on Oct 2, 2018
  2. self-assigned this
    on Oct 9, 2018
  3. added
    type: cleanupAn internal cleanup or hygiene concern.
    type: processA process-related concern. May include testing, release, or the like.
    and removed
    priority: p2Moderately-important priority. Fix may not be included in next release.
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    type: processA process-related concern. May include testing, release, or the like.
    on Oct 23, 2018
  4. chingor13 commented on Nov 9, 2018

    @chingor13
    ContributorAuthor

    It turns out we were running the javadoc tests in Java 7 which was allowing javadoc to build with stuff caught in Java 8. We build our docs with Java 8 so it was failing at doc building time.

  5. added a commit that references this issue on Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

status: in progressThere is an open PRtype: cleanupAn internal cleanup or hygiene concern.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions