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

publish java docs #158

Open
strantalis opened this issue Sep 1, 2024 · 0 comments
Open

publish java docs #158

strantalis opened this issue Sep 1, 2024 · 0 comments

Comments

@strantalis
Copy link
Member

Publish java docs to https://www.javadoc.io/ so consumers of the sdk can go to place to understand how they can interact with our sdk. This will require us to follow the javadoc standard when commenting our code.

https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

Acceptance Criteria:

  • Docs published to javadocs.io
  • Code is commented following javadoc convention
  • Stretch goal of have pr check for missing javadoc comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant