docs: use {@code} instead of {@link} for primitive types in factory Javadoc#128
Merged
Anush008 merged 1 commit intoJun 20, 2026
Merged
Conversation
…avadoc
{@link} requires a reference to a program element (class, method, or field), so
it cannot resolve a primitive type. Several factory classes use {@link long},
{@link int}, {@link double}, {@link boolean}, and {@link float}, which produce
"reference not found" Javadoc warnings and render as broken links in the
published API reference. Replace them with {@code <primitive>}, the correct tag
for an inline primitive type name. Real class links are left unchanged.
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
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.
What
Several factory classes document primitive parameter/source types with
{@link long},{@link int},{@link double},{@link boolean}, and{@link float}.{@link}requires a reference to a program element (a class, method, or field), so it cannot resolve a primitive type. As written, these tags emitreference not foundJavadoc warnings and render as broken links in the published API reference at https://qdrant.github.io/java-client.This replaces
{@link <primitive>}with{@code <primitive>}, the correct tag for rendering a primitive type name as inline code. Genuine class references (e.g.{@link Query},{@link StartFrom},{@link VectorInput},{@link String}) are left unchanged.Why
CONTRIBUTING.mdasks that code build with no warnings and that docstrings be appropriate, since the API reference is published.Changes
8 occurrences across 5 files (comment-only, no behavior or API change):
PointIdFactory— point id fromlongQueryFactory— query fromlongStartFromFactory— start-from fromfloatandintValueFactory— value fromlong,double,booleanVectorInputFactory— vector input fromlong