boswelja / Ephemeris

The flexible Android calendar library!
MIT License
10 stars 3 forks source link

API documentation #71

Closed EdricChan03 closed 2 years ago

EdricChan03 commented 2 years ago

Is your feature request related to a problem? Please describe. It would be nice to see a brief summary of all the public-facing APIs the library has to offer

Describe the solution you'd like Dokka can be used to auto-generate such docs.

Describe alternatives you've considered N/A

Other I'm currently working on a draft implementation of Dokka support which can be found in the feat/dokka branch (of my own fork)

EdricChan03 commented 2 years ago

Todos

Resources

Real-world implementations

Source Code Dokka link
Diskord https://jesselcorbett.gitlab.io/diskord/
Kotlinx.coroutines https://kotlin.github.io/kotlinx.coroutines/
Coil https://coil-kt.github.io/coil/api/
boswelja commented 2 years ago

What does a typical deployment look like? Is is a separate branch in the same repo? Edit: Yep, looks like they commit to a gh-pages branch