spring-projects / spring-projects/spring-framework
Include "since" info in generated Javadoc for new and deprecated APIs
Open
Nobody has claimed this yet.
type: documentation
- Dominant language
- Java
- Stars
- 60.2k
- Forks
- 38.8k
- Avg merge
- 5d 2h
- Merged PRs (30d)
- 27
Description
Overview
Recent versions of the javadoc command support -since and -since-label options which allow @since and @Deprecated(since=...) information to be included in the generated Javadoc HTML.
Examples for JDK 24
Examples for Spring Framework.
Screenshots taken from local build.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Spring Framework build configuration that generates Javadoc and review how its options are currently set. Verify the available Java APIs and deprecation metadata, then confirm that generated HTML includes new-API and deprecated-API information comparable to the linked JDK examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100