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

Improve code documentation #111

Merged
merged 11 commits into from
Feb 1, 2024
Merged

Improve code documentation #111

merged 11 commits into from
Feb 1, 2024

Conversation

wzieba
Copy link
Collaborator

@wzieba wzieba commented Jan 30, 2024

Description

This PR improves Javadoc/KDoc comments, that are shipped with the SDK.

During the work on the PR, I've experimented with generating Dokka-powered documentation and storing it on GitHub Actions (sample: https://parsely.github.io/parsely-android/) but I've made the decision that it'll be better to be cohesive with the rest of the platforms and have the documentation at https://docs.parse.ly/android-sdk/

To test

Like with #106 , please verify if the comments make sense to you.

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ca04c4f) 70.54% compared to head (5742c39) 70.54%.
Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #111   +/-   ##
=======================================
  Coverage   70.54%   70.54%           
=======================================
  Files          21       21           
  Lines         404      404           
  Branches       49       49           
=======================================
  Hits          285      285           
  Misses        104      104           
  Partials       15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Base automatically changed from remove_unneeded_methods_from_api to main February 1, 2024 11:04
@wzieba wzieba changed the title Improve code documentation. Generate and host it on GitHub Pages Improve code documentation Feb 1, 2024
@wzieba wzieba marked this pull request as ready for review February 1, 2024 14:41
@wzieba wzieba requested a review from iangmaia February 1, 2024 14:42
@wzieba wzieba merged commit 3ae9382 into main Feb 1, 2024
3 checks passed
@wzieba wzieba deleted the improve_javadoc branch February 1, 2024 15:53
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

Successfully merging this pull request may close these issues.

2 participants