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.

Sign up for GitHub

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

Jump to bottom

Setup Dokka and cleanup SDK API #5726

Closed
5 of 7 tasks
bmarty opened this issue Apr 11, 2022 · 2 comments
Closed
5 of 7 tasks

Setup Dokka and cleanup SDK API #5726

bmarty opened this issue Apr 11, 2022 · 2 comments
Assignees
@bmarty
Labels
matrix-sdk T-Task Refactoring, enabling or disabling functionality, other engineering tasks
Projects
Android App Team

Comments

@bmarty
Copy link
Member

bmarty commented Apr 11, 2022 •
edited

  • Setup Dokka to generate documentation of our Matrix SDK API
  • Host generated documentation somewhere (where?). Do something like https://matrix-org.github.io/matrix-rust-sdk/ if possible ?
  • Cleanup SDK api. Add internal keyword, move internal classes used by the app to api package (it will fix a bunch of TODOs!). Generated doc should not contain documented classes from the internal package.
  • Consider usage of explicitApi. See https://kotlinlang.org/docs/whatsnew14.html#explicit-api-mode-for-library-authors
  • Ensure there is a changelog .sdk file to explain what has been moved/updated
  • Add missing API documentation
  • Ensure that the CI checks that app modules do not import classes from internal package (update our check tool)
@bmarty bmarty added matrix-sdk T-Task Refactoring, enabling or disabling functionality, other engineering tasks labels Apr 11, 2022
@bmarty bmarty self-assigned this Apr 11, 2022
@RiotRobot RiotRobot added this to Incoming in Issue triage Apr 11, 2022
@bmarty bmarty moved this from Incoming to Closed in Issue triage Apr 11, 2022
@bmarty bmarty removed this from Closed in Issue triage Apr 11, 2022
@bmarty bmarty added this to Current Sprint in Android App Team Apr 11, 2022
@bmarty bmarty mentioned this issue Apr 12, 2022
Merged
15 tasks
@bmarty bmarty mentioned this issue Apr 14, 2022
Merged
@manuroe manuroe moved this from Current Sprint to In progress in Android App Team Apr 19, 2022
@bmarty
Copy link
Member Author

bmarty commented May 5, 2022

Documentation is hosted here: https://matrix-org.github.io/matrix-android-sdk2/

@bmarty
Copy link
Member Author

bmarty commented May 5, 2022

missing documentation is added on a regular basis

@bmarty bmarty closed this as completed May 5, 2022
Android App Team automation moved this from In progress to Merged May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bmarty bmarty

Labels
matrix-sdk T-Task Refactoring, enabling or disabling functionality, other engineering tasks
Projects
Android App Team
Merged
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bmarty