google / android-fhir

The Android FHIR SDK is a set of Kotlin libraries for building offline-capable, mobile-first healthcare applications using the HL7® FHIR® standard on Android.
https://google.github.io/android-fhir/
Apache License 2.0
484 stars 285 forks source link

Integrate Dokka into all SDK components and build API reference docs #1457

Closed williamito closed 2 years ago

williamito commented 2 years ago

Describe the Issue Kotlin's documentation generation tool is called Dokka. API reference docs should be available for developers, and rebuilding them should be a part of every release. Looking at the diff in generated reference docs between versions is a strong tool for understanding changes between versions. Code-level documentation is also tightly integrated with Android Studio, e.g. shows up when you hover over components in the code. Generating docs would also help identify where documentation is lacking or not keeping up with style guide expectations.

williamito commented 2 years ago

I created a PR that adds simple configs for Dokka. In addition I think we could:

Would love feedback on the PR and a discussion on how to proceed.