Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Revisit public API and provide missing javadocs #2016

Closed
9 tasks
dzikoysk opened this issue Oct 12, 2023 · 4 comments · Fixed by #2029
Closed
9 tasks

Revisit public API and provide missing javadocs #2016

dzikoysk opened this issue Oct 12, 2023 · 4 comments · Fixed by #2029
Labels
FEATURE REQUEST GOOD FIRST ISSUE HELP WANTED

Comments

@dzikoysk
Copy link
Member

dzikoysk commented Oct 12, 2023 •
edited

List of crucial components that don't have any javadocs:

  • JavalinConfig + associated classes
  • Bundled plugin configs
  • EventManager
  • RequestLogger#handle
  • Handler#handle, ExceptionHandler#handle
  • FileRenderer#render
  • Cookie
  • ContentType
  • ?

If possible, we could probably also link Javalin's docs/write examples directly in javadocs.
@dzikoysk dzikoysk mentioned this issue Oct 12, 2023
Closed
@zugazagoitia
Copy link
Member

We should also provide some link to the hosted Javadocs. Reposilite does this by default right?

@dzikoysk dzikoysk mentioned this issue Oct 13, 2023
Merged
@tipsy
Copy link
Member

tipsy commented Oct 14, 2023

We should also provide some link to the hosted Javadocs. Reposilite does this by default right?

https://javadoc.io/doc/io.javalin/javalin/latest/index.html

@xgouchet
Copy link
Contributor

Hi Javalin team, I'm happy to contribute to this project and submit a PR if no one else is working on this already :)

@zugazagoitia
Copy link
Member

Hi Javalin team, I'm happy to contribute to this project and submit a PR if no one else is working on this already :)

Sure thing, go ahead!

@xgouchet xgouchet mentioned this issue Oct 27, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
FEATURE REQUEST GOOD FIRST ISSUE HELP WANTED
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add missing javadoc xgouchet/javalin
4 participants
@xgouchet @tipsy @dzikoysk @zugazagoitia