CODEWITHSUNDEEP
scalascaladoc
VasiliNovikov
VasiliNovikov

Reputation: 10236

How to use @See scaladoc?

What is the exact syntax of using @See scaladoc? How do I reference:

?

Upvotes: 13

Views: 2680

Answers (1)

VasiliNovikov
VasiliNovikov

Reputation: 10236

The syntax is the same as with any other part of the scaladoc. You basically add the @see notation, and then write pure text describing the reference. Examples:

  • @see [[method]]
  • @see [[YourCurrentClass.method]]
  • @see [[YourCurrentClass]]
  • @see See [[scala.concurrent.Future]] for more
  • @see See [[http://example.com the full documentation]] on possible values of ABC

EDIT:

official documentation on @see: https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#usage-tags

official documentation on references in general: https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#markup

Upvotes: 12

Related Questions