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.

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

Adding JSDoc comments throughout #1071

Closed
JerrettDavis opened this issue Apr 28, 2021 · 3 comments
Closed

Adding JSDoc comments throughout #1071

JerrettDavis opened this issue Apr 28, 2021 · 3 comments

Comments

@JerrettDavis
Copy link
Contributor

JerrettDavis commented Apr 28, 2021

Is your feature request related to a problem? Please describe.
It appears that while there's excellent documentation for the library, very little of the code itself has attached in-code documentation. This often requires me to look directly in the library's code to really understand what a method is doing. Implementing JSDocs throughout would allow IDE code-completion and code-hints to better help other developers.

Describe the solution you'd like
Add JSDocs to all publicly facing methods.

Describe alternatives you've considered
None

Additional context
None

@FabianGosebrink
Copy link
Collaborator

Hey, thanks for the input. Yes, I would love to do this while we want to keep the documentation to the public OidcSecurityService as he provides a facade as entrypoint for the library.

I would like to see this asap, so we can branch from main and do a PR from there. Would you like to help with that?

Thanks

@JerrettDavis
Copy link
Contributor Author

I'm more than happy to start up a branch and get to documenting. I should be able to get on it here in a few hours after I wrap up my day's work.

@FabianGosebrink
Copy link
Collaborator

Take it easy, no rush. I can definitely review and help you with that. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants