Skip to content

Conversation

@lewisbirks
Copy link
Contributor

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 is
https://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 as jooby-awssdk-v[1|2] or jooby-commons-email then it would be used there as well.

Other minor fixes have also been applied where noticed.

…arated by `,`

Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Copy link
Contributor Author

@lewisbirks lewisbirks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some questions for when the code is being reviewed 🙂

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]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are many overloads here, which version is wanted or do we want all of the overloads?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added as part of a54ace5

@jknack
Copy link
Member

jknack commented Jun 23, 2025

@lewisbirks Thank you! Appreciated the time and fixes.

Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
Family of send methods include:

- javadoc:Context[send, byte[\]]
- javadoc:Route[consumes, io.jooby.MediaType...]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just had a thought, does this one belong here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed as part of a54ace5

Signed-off-by: Lewis Birks <22620804+lewisbirks@users.noreply.github.com>
@lewisbirks
Copy link
Contributor Author

@jknack this is all good to be reviewed now, no further questions from me 🙂

@jknack jknack added this to the 3.10.0 milestone Jun 29, 2025
@jknack jknack merged commit d27b7eb into jooby-project:3.x Jun 29, 2025
1 check passed
@lewisbirks lewisbirks deleted the fix-docs branch July 1, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants