He-Pin opened a new pull request, #1119:
URL: https://github.com/apache/pekko-http/pull/1119
## Motivation
Running `sbt doc` produces javadoc warnings in Java source files across
multiple pekko-http modules:
- Multi-line `{@link}` tags cause "Could not find any member to link"
warnings
- Scala-style `[[...]]` links are not recognized by javadoc
- Invalid link syntax like `{@link Uri::port::}` cannot be resolved
- Public methods and classes missing javadoc comments
## Modification
- `Authority.java`: Fix invalid `{@link Uri::port::}` to `{@link Uri#port()}`
- `HttpApp.java`: Replace Scala-style `[[ActorSystem]]` with `{@link
ActorSystem}`, use fully qualified `{@link java.lang.Throwable}`
- `HttpHeader.java`: Fix multi-line `{@link}` tag formatting
- `Multipart.java`: Replace Scala-style `[[...]]` links with `{@code}`
- `CustomHeader.java`, `ModeledCustomHeaderFactory.java`: Fix multi-line
`{@link}` tags
- `Jackson.java` (jackson & jackson3): Add javadoc to public methods
- PetStore and SimpleServer examples: Add javadoc to public classes and
methods
## Result
Javadoc warnings in Java source files are eliminated, improving
documentation quality.
## Tests
Manually verified via `sbt doc`
## References
Follow-up to #908
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
