-
-
Notifications
You must be signed in to change notification settings - Fork 202
Fix Javadoc links on the site #3700
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…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>
lewisbirks
left a comment
There was a problem hiding this 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 🙂
docs/asciidoc/responses.adoc
Outdated
| // Code review comment: is this supposed to be jooby databuffer or nio bytebuffer | ||
| - javadoc:Context[send, java.nio.ByteBuffer] |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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]There was a problem hiding this comment.
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
|
@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>
docs/asciidoc/responses.adoc
Outdated
| Family of send methods include: | ||
|
|
||
| - javadoc:Context[send, byte[\]] | ||
| - javadoc:Route[consumes, io.jooby.MediaType...] |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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>
|
@jknack this is all good to be reviewed now, no further questions from me 🙂 |

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.