Doc

Documentation of a UGen.

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

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

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

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

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
val args: Map[String, List[String]]

maps argument names to documentation for that argument, given as a list of paragraphs.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val body: List[String]

the main UGen description text, as a list of paragraphs.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val examples: List[Example]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val links: List[String]

list of cross-links to related UGens.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputs: Map[String, List[String]]

maps output names to documentation for that output, given as a list of paragraphs.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val warnPos: Boolean

if true, indicates that the argument positions are different than in SC-Lang, warranting an explicit warning to the user to raise awareness.

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]) extends Product with Serializable

Instance Constructors

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

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val args: Map[String, List[String]]

final def asInstanceOf[T0]: T0

val body: List[String]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val examples: List[Example]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val links: List[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputs: Map[String, List[String]]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val warnPos: Boolean

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped