How to disambiguate links to methods in scaladoc?

后端 未结 4 1458
梦谈多话
梦谈多话 2021-02-03 19:57

I\'m documenting a Scala class with overloaded methods. How can I distinguish them when referring to them in scaladoc comments? For example, if I have

/**
 * The         


        
4条回答
  •  别那么骄傲
    2021-02-03 20:33

    The following seems do the trick in Scala 2.10.

    /**
     * The most important method is [[Doc.foo[A]:A*]].
     */
    

    And here is some hint scaladoc gives me:

    [warn] Quick crash course on using Scaladoc links
    [warn] ==========================================
    [warn] Disambiguating terms and types: Prefix terms with '$' and types with '!' in case both names are in use:
    [warn]  - [[scala.collection.immutable.List!.apply class List's apply method]] and
    [warn]  - [[scala.collection.immutable.List$.apply object List's apply method]]
    [warn] Disambiguating overloaded members: If a term is overloaded, you can indicate the first part of its signature followed by *:
    [warn]  - [[[scala.collection.immutable.List$.fill[A](Int)(⇒A):List[A]* Fill with a single parameter]]]
    [warn]  - [[[scala.collection.immutable.List$.fill[A](Int,Int)(⇒A):List[List[A]]* Fill with a two parameters]]]
    [warn] Notes: 
    [warn]  - you can use any number of matching square brackets to avoid interference with the signature
    [warn]  - you can use \. to escape dots in prefixes (don't forget to use * at the end to match the signature!)
    [warn]  - you can use \# to escape hashes, otherwise they will be considered as delimiters, like dots.
    

提交回复
热议问题