fix: fix javadoc warnings in Java sources across pekko-http modules#1119
Merged
Conversation
He-Pin
added a commit
to He-Pin/incubator-pekko-http
that referenced
this pull request
Jul 4, 2026
Motivation:
Additional javadoc warnings found:
- Scala-style `[[...]]` links in HttpEntity, HttpMessage, HttpMethod,
ServerSentEvent, ContentTypeResolver
- Remaining multi-line `{@link}` tags in HttpApp.java
Modification:
- Replace `[[value]]` with `{@link #value()}` in HttpMethod.java
- Replace `[[withSizeLimit]]` with `{@link #withSizeLimit(long)}` in HttpEntity.java
- Replace `[[org.apache.pekko.stream.javadsl.Source]]` with `{@code}` in HttpEntity.java and HttpMessage.java
- Replace `[[ServerSentEvent]]` with `{@link ServerSentEvent}` in ServerSentEvent.java
- Replace `[[...ContentType]]` with `{@link}` in ContentTypeResolver.java
- Fix remaining multi-line `{@link}` tags in HttpApp.java
Result:
All remaining javadoc warnings in Java sources are eliminated.
Tests:
Manually verified via grep pattern search
References:
Follow-up to apache#1119
Motivation:
Running `sbt doc` produces javadoc and compilation warnings in Java
source files across http-core, http, and http-jackson modules:
multi-line {@link} tags, Scala-style [[...]] links, invalid link
syntax, unchecked casts, and deprecated API usage.
Modification:
- Fix invalid {@link} tags in Authority.java, HttpApp.java,
HttpHeader.java, Multipart.java, CustomHeader.java
- Replace Scala-style [[...]] links with {@code}/{@link} in
HttpEntity, HttpMessage, HttpMethod, ServerSentEvent, ContentTypeResolver
- Add javadoc to public methods in Jackson.java (jackson & jackson3)
and example classes
- Add @SuppressWarnings("deprecation") to ContentTypes, Coder,
Jackson, ParserSettingsTest
- Add @SuppressWarnings("unchecked") to AttributeKeys
- Apply javafmt to all modified Java files
Result:
All javadoc and compilation warnings in Java sources are eliminated.
Tests:
Manually verified via `sbt doc` and grep pattern search
References:
Follow-up to apache#908
He-Pin
force-pushed
the
fix/javadoc-warnings
branch
from
671dc3c to
645882d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Running
sbt docproduces javadoc warnings in Java source files across multiple pekko-http modules:{@link}tags cause "Could not find any member to link" warnings[[...]]links are not recognized by javadoc{@link Uri::port::}cannot be resolvedModification
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 formattingMultipart.java: Replace Scala-style[[...]]links with{@code}CustomHeader.java,ModeledCustomHeaderFactory.java: Fix multi-line{@link}tagsJackson.java(jackson & jackson3): Add javadoc to public methodsResult
Javadoc warnings in Java source files are eliminated, improving documentation quality.
Tests
Manually verified via
sbt docReferences
Follow-up to #908