Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Tooling to generate Kotlin documentation.

This module contains configuration for generating Kotlindoc that is hosted at firebase.github.io.

To generate documentation for all "supported" SDKs(ones that have Kotlin extensions) run:

./gradlew :kotlindoc:dokka

To generate documentation for a subset of SDKs run:

./gradlew -PkotlindocProjects=":firebase-common,:firebase-firestore" :kotlindoc:dokka

The output will be located in kotlindoc/build/dokka/html.

To update the live reference, create a PR with the contents of the above directory into the gh-pages branch.