scaladocumentationscaladoc

Document a recurring argument with a built-in type


How to document p?

class A {
    def (p: Map[String, String]): Unit = {}
}

class B {
    def (p: Map[String, String], ...): Unit = {}  
}

Solution

  • I think you are looking for type aliases:

    /** Some doc for P type */
    type MyPType = Map[String, String]
    
    def someMethod(p: MyPType) = ...