jakartaee / jakartaee/common-annotations-api

Incorrect javadoc since value in `@Nonnull` and `@Nullable`

Open Beginner friendly
#144 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
67
Forks
42
PR merge metrics
No merged PRs in 30d

Description

Since tag value in javadoc of annotations @Nonnull and @Nullable should be 2.1 instead of 2.0,
according to spec : https://jakarta.ee/specifications/annotations/2.1/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Java source for the Javadoc of @Nonnull and @Nullable, then compare their Since tag with the Jakarta Annotations 2.1 specification linked in the issue. Update both values from 2.0 to 2.1 and verify that the generated Javadoc reflects the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.