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
Add missing javadoc #2029
Add missing javadoc #2029
Conversation
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 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.
Good job @xgouchet :) A few things that I'd address here:
- Some comments don't really provide useful information. I'm mainly talking about method parameters like e.g.
@param contentType the content type to add
onfun add(contentType: ContentType) {
method. I think it's fine to just omit it & have just one simple one-liner comment about the function as a whole. - Highlight that methods have default values for parameters. It might be a good idea to describe the default behavior in the docs, especially when
@JvmOverloads
is used. - I'd reduce unnecessary spacing - empty lines & use one-liners whenever possible (Context.kt is a good visual reference here)
77f4c5b
to
0817765
Compare
0817765
to
9c2a50e
Compare
I followed your suggestion @dzikoysk , and also added missing documentation on the |
This looks really good @xgouchet ! Are you ready for merge? |
Yes all good for me |
LGTM, I think these docs will help our users. It's not only describing particular functions, but also brings a general context around them :) |
Thank you very much @xgouchet ! |
This PR adds Javadoc/KDoc documentation on public classes, data classes, functions and enums to make it easier to use from IDEs.
Fixes #2016
Specifically:
io.javalin.config
packageRequestLogger#handle
,Handler#handle
,ExceptionHandler#handle
FileRenderer#render
Cookie
ContentType
andHandlerType
enums (among others)Note
Most documentation text was copy-pasted from the MDN Docs pages, and the Javalin documentation pages.