Giters

auth0 / java-jwt

Java implementation of JSON Web Token (JWT)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Javadoc contains dead links to readme

Farbfetzen opened this issue · comments

commented

Checklist

  • I have looked into the Readme and Examples, and have not found a suitable solution or answer.
  • I have looked into the API documentation and have not found a suitable solution or answer.
  • I have searched the issues and have not found a suitable solution or answer.
  • I have searched the Auth0 Community forums and have not found a suitable solution or answer.
  • I agree to the terms within the Auth0 Code of Conduct.

Description

The documentation in the code contains some dead links to the readme. For example see https://github.com/auth0/java-jwt/blob/master/lib/src/main/java/com/auth0/jwt/algorithms/Algorithm.java#L187. There is no section "hmac-key-length-and-security" in the current readme.

Reproduction

Click on the link in the javadoc of com.auth0.jwt.algorithms.Algorithm#HMAC512(java.lang.String).

Additional context

No response

java-jwt version

4.4.0

Java version

any

commented

Thanks @Farbfetzen for raising! We'll get this fixed up this week. If you'd like to open a PR to fix broken links you see, feel free and we can review, otherwise we'll get something out this week.