Fix Javadoc links on the site#3700
Merged
jknack merged 41 commits intojooby-project:3.xfrom Jun 29, 2025
Merged
Conversation
…arated by `,` Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
lewisbirks
commented
Jun 23, 2025
Contributor
Author
lewisbirks
left a comment
There was a problem hiding this comment.
Just some questions for when the code is being reviewed 🙂
docs/asciidoc/responses.adoc
Outdated
Comment on lines
776
to
777
| // Code review comment: is this supposed to be jooby databuffer or nio bytebuffer | ||
| - javadoc:Context[send, java.nio.ByteBuffer] |
Contributor
Author
There was a problem hiding this comment.
There are many overloads here, which version is wanted or do we want all of the overloads?
Contributor
Author
There was a problem hiding this comment.
This is what it would look like with all the send overloads taken into account
- javadoc:Context[send, byte[\]]
- javadoc:Context[send, byte[\]...]
- javadoc:Context[send, io.jooby.buffer.DataBuffer]
- javadoc:Context[send, io.jooby.FileDownload]
- javadoc:Context[send, io.jooby.StatusCode]
- javadoc:Context[send, java.io.InputStream]
- javadoc:Context[send, java.lang.String]
- javadoc:Context[send, java.lang.String, java.nio.charset.Charset]
- javadoc:Context[send, java.nio.ByteBuffer]
- javadoc:Context[send, java.nio.ByteBuffer[\]]
- javadoc:Context[send, java.nio.channels.FileChannel]
- javadoc:Context[send, java.nio.channels.ReadableByteChannel]
- javadoc:Context[send, java.nio.file.Path]
Member
|
@lewisbirks Thank you! Appreciated the time and fixes. |
Signed-off-by: Lewis Birks <[email protected]>
Signed-off-by: Lewis Birks <[email protected]>
lewisbirks
commented
Jun 24, 2025
docs/asciidoc/responses.adoc
Outdated
| @@ -773,10 +773,10 @@ Family of send methods include: | |||
|
|
|||
| - javadoc:Context[send, byte[\]] | |||
| - javadoc:Route[consumes, io.jooby.MediaType...] | |||
Contributor
Author
There was a problem hiding this comment.
Just had a thought, does this one belong here?
Signed-off-by: Lewis Birks <[email protected]>
Contributor
Author
|
@jknack this is all good to be reviewed now, no further questions from me 🙂 |
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.

I was having a look over the Jooby documentation on jooby.io and noticed that when linking to methods in the javadoc the links weren't working as expected. For example in the Context section there is a link to the
Context#locales()method, the generated link for this ishttps://www.javadoc.io/doc/io.jooby/jooby/latest/io.jooby/io/jooby/Context.html#locales--when it needs to be
https://www.javadoc.io/doc/io.jooby/jooby/latest/io.jooby/io/jooby/Context.html#locales()I have updated the JavadocProcessor to handle this as well as handling links to jooby javadoc from other artifacts (for example when linking to the netty server implementation in the Worker Executor section)
I've had to introduce another attribute,
module, as well for the processor when the maven artifact doesn't line up with the declared module. This is only used in the DB Scheduler section for now but if the documentation was updated to include javadoc links to artifacts such asjooby-awssdk-v[1|2]orjooby-commons-emailthen it would be used there as well.Other minor fixes have also been applied where noticed.