Class

mdoc

Variable

Related Doc: package mdoc

Permalink

final class Variable extends AnyRef

A captured variable in a code fence.

Example, the code fence below has two statements:

- The first statement has a single variable with name x - The second statement has a two variables with names y and z

```scala mdoc
val x = 1
val (y, z) = (2, 3)
```
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Variable
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. val indexOfStatementInCodeFence: Int

    Permalink

    the index of the enclosing statement within the enclosing code fence.

    the index of the enclosing statement within the enclosing code fence. For example, in

    ```scala
    val x = 1
    val y = 2
    ```

    The variable y has index 1 and variable x has index 0.

  12. val indexOfVariableInStatement: Int

    Permalink

    the index of this variable in the enclosing statement.

    the index of this variable in the enclosing statement. For example, in val (a, b) = ??? the variable a has index 0 and variable b has index 1.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isToString: Boolean

    Permalink
  15. def isUnit: Boolean

    Permalink
  16. val name: String

    Permalink

    the variable name, for example x

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. val pos: Position

    Permalink
  21. val runtimeValue: Any

    Permalink

    the runtime value of this variable.

  22. val staticType: String

    Permalink

    the pretty-printed static type of this variable, for example List[Int]

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

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    Variable → AnyRef → Any
  25. val totalStatementsInCodeFence: Int

    Permalink

    the total number of statement in the enclosing code fence.

    the total number of statement in the enclosing code fence. For example, the total number is 2 for the code fence below.

    ```scala
    val x = 1
    val y = 2
    ```
  26. val totalVariablesInStatement: Int

    Permalink

    The total number of variables in this statements.

    The total number of variables in this statements. For example, in val a = N the total number is 1 and for val (a, b) = ... the total number is 2.

  27. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped