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

Update documentation for pillarbox-analytics #770

Merged
merged 10 commits into from
Nov 1, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Oct 29, 2024

Pull request

Description

Update the documentation for pillarbox-analytics.

Changes made

  • Update PillarboxAndroidLibraryPublishingPlugin to support loading module documentation from either Module.md or docs/README.md.
  • Update docs/README.md to work with Dokka (mainly removing images) and improving wording and samples.
  • Remove Module.md.
  • Update the KDoc for every public class/method/interface.
  • Make TCEventExtensions internal. I don't think this was meant to be public. Let me know if I should change it back.

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@MGaetan89 MGaetan89 self-assigned this Oct 29, 2024
Copy link

github-actions bot commented Oct 29, 2024

Code Coverage

Overall Project 47.8% -0.1% 🟢
Files changed 32.61% 🟢

Module Coverage
:pillarbox-analytics 88.16% 🟢
Kover Gradle Plugin XML report for :plugins 7.46% -2.18% 🟢
Files
Module File Coverage
:pillarbox-analytics CommandersActPageView.kt 100% 🟢
TCEventExtensions.kt 100% 🟢
TCMediaEvent.kt 100% 🟢
MediaEventType.kt 100% 🟢
CommandersActEvent.kt 100% 🟢
CommandersActLabels.kt 100% 🟢
ComScorePageView.kt 100% 🟢
ComScoreUserConsent.kt 100% 🟢
AnalyticsConfig.kt 100% 🟢
UserConsent.kt 100% 🟢
CommandersActSrg.kt 75.56% 🟢
SRGAnalytics.kt 49.74% 🟢
CommandersAct.kt 0% 🟢
ComScore.kt 0% 🟢
Kover Gradle Plugin XML report for :plugins PillarboxAndroidLibraryPublishingPlugin.kt 0% -6.55% 🟢

@MGaetan89 MGaetan89 changed the title Update documentation in ch.srgssr.pillarbox.analytics Update documentation for pillarbox-analytics Oct 29, 2024
pillarbox-analytics/docs/README.md Outdated Show resolved Hide resolved
pillarbox-analytics/docs/README.md Show resolved Hide resolved
pillarbox-analytics/docs/README.md Show resolved Hide resolved
Base automatically changed from update_dokka to main October 29, 2024 14:52
@MGaetan89 MGaetan89 force-pushed the revisit_analytics_documentation branch from 604c359 to 9f290d9 Compare October 29, 2024 16:26
@MGaetan89 MGaetan89 changed the base branch from main to deploy_javadoc October 29, 2024 16:26
Base automatically changed from deploy_javadoc to main October 31, 2024 11:22
@MGaetan89 MGaetan89 force-pushed the revisit_analytics_documentation branch from 817283c to 38fc48d Compare October 31, 2024 12:27
@MGaetan89
Copy link
Member Author

I've updated the PR so it uses the new https://android.pillarbox.ch/api URL

@MGaetan89 MGaetan89 added this pull request to the merge queue Nov 1, 2024
Merged via the queue into main with commit c4def7f Nov 1, 2024
9 checks passed
@MGaetan89 MGaetan89 deleted the revisit_analytics_documentation branch November 1, 2024 16:30
@MGaetan89 MGaetan89 linked an issue Nov 3, 2024 that may be closed by this pull request
@MGaetan89 MGaetan89 added the documentation Improvements or additions to documentation label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Provide a consolidated documentation for Pillarbox
2 participants