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

Add Javadocs to all classes and variables #643

Open
jblayneyXpanxion opened this issue Oct 15, 2019 · 0 comments
Open

Add Javadocs to all classes and variables #643

jblayneyXpanxion opened this issue Oct 15, 2019 · 0 comments

Comments

@jblayneyXpanxion
Copy link

Issue Details

Type of Issue (check one with "X")

[X] Bug Report => Please search GitHub for a similar issue or PR before submitting
[ ] Feature Request => Please ensure feature is not already in progress
[ ] Support Request => Please do not submit support requests here, instead see: https://discourse.oss.antheminc.com/

Current Behavior

Developer guesses what classes/methods/vars do to the best of their ability via var-name/method-name/class-name. May also result in more time than necessary spent looking through nimbus documentation.

Expected Behavior

"Production" code for a library used at scale would expect updated & accurate javadoc for all methods/classes/variables available to the developer using the framework.

Javadoc auto-published to an endpoint for easy external reference.

  • Add example calls/values/usage notes.
  • Why would the developer use this method/var/class?
  • What are the default values/function/behavior?
  • What state does the method/class/var mutate or return?
  • What does the class add to the Nimbus framework that is not available in other classes?

Benefits

  • Saves time for any developer implementing features with the framework a lot of guess & check time.
  • More accurate coding to best practices, smaller chance of mis-using functionality for unintended purposes.
  • Better developer experience, easier to use, more likely to rope in external contributions or suggestions.

How to Reproduce the Issue

Steps to Reproduce

Hover over elements/classes/variables represented by the nimbus framework... nothing except namespace and method/var/class prototype shows up.

Code Snippet

Environment Details

  • Nimbus Version:

current.

  • Browser:

N/A

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