ScalaColliderUGens-api/de.sciss.synth/UGenSpec/Doc

Doc

final case

class Doc(body: List[String], args: Map[String, List[String]], outputs: Map[String, List[String]], links: List[String], warnPos: Boolean, examples: List[Example])

Documentation of a UGen.

Value Params

args: maps argument names to documentation for that argument, given as a list of paragraphs.
body: the main UGen description text, as a list of paragraphs.
links: list of cross-links to related UGens.
outputs: maps output names to documentation for that output, given as a list of paragraphs.
warnPos: if true, indicates that the argument positions are different than in SC-Lang, warranting an explicit warning to the user to raise awareness.

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Value members

Inherited methods

Inherited from: Product

Inherited from: Product