- Home
- Documentation Generators
- Scaladoc
On the recordRead 9 Oct 202613 facts
Scaladoc
Plans and prices
Scaladoc
Free
No paid plans or usage limits stated
Read 9 Oct 2026 · docs.scala-lang.org
On the record
- Audience
- Scaladoc documentation helps library users learn about a library, library authors write documentation, and developers generate library documentation.docs.scala-lang.org · read 9 Oct 2026
- Comment inheritance
- Scaladoc can inherit comments from superclasses and traits implicitly or through the @inheritdoc tag.docs.scala-lang.org · read 9 Oct 2026
- Comment tags
- Tags include @param, @tparam, @return, @throws, @example, @since, and @deprecated for documenting code entities.docs.scala-lang.org · read 9 Oct 2026
- Generated interface
- Generated Scaladoc can show package breadcrumbs, linear supertypes, known subclasses, type hierarchies, and links to online source when available.docs.scala-lang.org · read 9 Oct 2026
- Generation
- API documentation can be generated as HTML using sbt or the scaladoc command-line tool, with sbt described as the easier option for complex projects.docs.scala-lang.org · read 9 Oct 2026
- Integrations
- The Scala documentation names sbt as the easiest and most commonly used way to generate Scaladoc from Scala code.docs.scala-lang.org · read 9 Oct 2026
- Limit
- The direct scaladoc command is harder to use with complex projects containing multiple Scala source files and library dependencies.docs.scala-lang.org · read 9 Oct 2026
- Maintainer context
- The Scala Center describes itself as an independent not-for-profit center at EPFL that coordinates open-source development of Scala libraries and tools.scala.epfl.ch · read 9 Oct 2026
- Markup
- Scaladoc comments support markup, including Markdown in Scala 3 and legacy Wikidoc syntax.docs.scala-lang.org · read 9 Oct 2026
- Purpose
- Scaladoc is Scala’s main documentation tool and generates documentation related to the structure of Scala source code from comments in that code.docs.scala-lang.org · read 9 Oct 2026
- Search
- Scaladoc supports searching for methods and fields by their types, and the documentation describes this feature as still in development.docs.scala-lang.org · read 9 Oct 2026
- Security
- The Scala security policy says releases are cryptographically signed with PGP keys and encourages private vulnerability reports.scala-lang.org · read 9 Oct 2026
- Static sites
- Scaladoc can create static sites for documentation and blog posts alongside generated API documentation.docs.scala-lang.org · read 9 Oct 2026
