spring-projects / spring-projects/spring-security

Links to Spring Framework missing from Javadoc

Open
#10,954 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

in: docs type: bug
Dominant language
Java
Stars
9.6k
Forks
6.3k
Avg merge
2d 11h
Merged PRs (30d)
52

Description

Related to #7868

A class that references objects in another Javadoc should link to that Javadoc. This worked in 4.2.12.RELEASE and onward, but stopped working again later on.

It can be fixed by configuring Javadoc links in the Gradle Javadoc class like so:

javadoc {
    options {
        links = [
            "https://dos.spring.io/spring/docs/$springFrameworkVersion/javadoc-api/",
            "https://docs.spring.io/spring-ldap/docs/$springLdapVersion/apidocs/",
            "https://docs.oracle.com/en/java/javase/11/docs/api/"
        ]
    }
}

Or programmatically in Groovy with an instance of StandardJavadocDocletOptions.

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

Start by locating the Gradle Javadoc configuration for the project and review the links example in the issue, including StandardJavadocDocletOptions. Verify the generated Javadoc for AbstractSecurityWebSocketMessageBrokerConfigurer and confirm references to Spring Framework, Spring LDAP, and Java APIs resolve to their external documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.