Improve code documentation #111
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
The content of this file will be added to the documentation at https://docs.parse.ly/android-sdk/
wzieba
changed the title
iangmaia
approved these changes
Feb 1, 2024
parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.kt
Outdated
Show resolved
Hide resolved
…r.kt Co-authored-by: Ian Guedes Maia <iangmaia@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.