Overview

Scaladoc is Scala’s main documentation tool. Scaladoc is a documentation system that lives in the comments of Scala source code and which generates documentation related to the code structure within which it is written. It is based on other comment based documentation systems like Javadoc.

There are three aspects of Scaladoc documentation:

• Using the Scaladoc interface – how to navigate and use generated Scaladoc documentation to learn more about a library.
• Scaladoc for Library Authors – how to add Scaladoc comments to generate documentation for your library.
• Generating documentation for your library with Scaladoc – how to use Scaladoc to generate documentation for your library.