Skip to main content

Scaladoc

Scaladoc​

We write inline documentation of code and public APIs using ScalaDoc.

When creating a new feature, you can view the documentation you've written by building the ScalaDoc locally with sbt:

sbt:chisel> unipublish / doc

This will build the documentation in unipublish/target/scala-2.13/unidoc, and you can view it by opening unidoc/index.html in your browser.