SRGSSR / pillarbox-android

The modern SRG SSR Pillarbox player targeting Android platforms

https://android.pillarbox.ch/api

MIT License

13 stars 1 forks source link

Update documentation for `pillarbox-cast` #774

Open MGaetan89 opened 2 days ago

MGaetan89 commented 2 days ago

Pull request

Description

Update the documentation for pillarbox-cast.

Changes made

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.

[!WARNING] This should be merged after #770!

Checklist

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

github-actions[bot] commented 2 days ago

Code Coverage

Overall Project	47.84%	🟢

Module	Coverage
:pillarbox-cast	0%	🟢

Files

|Module|File|Coverage|| |:-|:-|:-|:-:| |:pillarbox-cast|[CastExtensions.kt](https://github.com/SRGSSR/pillarbox-android/blob/cbd0055d96385aa47e7f7e9f384270161fa14590/pillarbox-cast%2Fsrc%2Fmain%2Fjava%2Fch%2Fsrgssr%2Fpillarbox%2Fcast%2FCastExtensions.kt)|0%|🟢| ||[CastButton.kt](https://github.com/SRGSSR/pillarbox-android/blob/cbd0055d96385aa47e7f7e9f384270161fa14590/pillarbox-cast%2Fsrc%2Fmain%2Fjava%2Fch%2Fsrgssr%2Fpillarbox%2Fcast%2Fwidget%2FCastButton.kt)|0%|🟢|

MGaetan89 commented 1 day ago

Converting to draft, until #775 and #770 are merged

MGaetan89 commented 15 hours ago

Conflicts have been fixed, and the branch has been updated with the latest version of revisit_analytics_documentation