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
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.
- Alphabetic
- By Inheritance
- Doc
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val args: Map[String, List[String]]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val body: List[String]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @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
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val links: List[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val outputs: Map[String, List[String]]
-
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
- @native() @throws( ... )
- val warnPos: Boolean