Home/ Questions/Q 6139141
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-23T17:57:09+00:00

I binged or googled for scaladoc 2.0 tutorial or example, I could not find

  • 0

I binged or googled for scaladoc 2.0 tutorial or example, I could not find anything, in fact not even a link to official scaladoc 2.0 documentation.
Anyone know where to find one?

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    docs.scala-lang.org is a more recent source of “Community-driven documentation for Scala” (thanks to the initiative lead by Heather Miller).
    (as edited by Martin Konicek in David James‘s original answer)
    The Scaladoc page is quite up-to-date.

    Martin Konicek asks in the comment how to make a simple Javadoc-like {@link}.
    (And {@link} isn’t mentioned in scala.tools.nsc.ast.DocComments.scala)

    He mentions that Scaladoc uses [[fullyQualifiedName]] instead of {@link}.

    Initial answer (July/Sept 2011)

    Right now, the most complete source of information I know about Scaladoc2 is in the new scala-lang.org Wiki.

    David James mentions in the comments the Syntax page, and the Tags and Annotations.

    The author page has examples, including a what’s new section:

    Authors of documentation no longer have to use HTML tags in their comments.
    Instead, Scaladoc supports a wiki-like syntax very similar to that used in Trac.
    In general, Scaladoc authors should no longer use HTML tags in documentation as Scaladoc may in the future also generate documentation in other formats than HTML.

    • 0