cli
API
Generated with
cli/mdoc

mdoc

package mdoc

Members list

Packages

package mdoc.internal

Type members

Classlikes

final class OnLoadContext

Attributes

Supertypes
class Object
trait Matchable
class Any
trait PostModifier

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PostModifier

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class PostModifierContext

Attributes

Supertypes
class Object
trait Matchable
class Any
final class PostProcessContext

Attributes

Supertypes
class Object
trait Matchable
class Any
trait PreModifier

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PreModifier

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class PreModifierContext

Attributes

Supertypes
class Object
trait Matchable
class Any
trait Reporter

Attributes

Supertypes
class Object
trait Matchable
class Any
trait StringModifier

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object StringModifier

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class Variable

A captured variable in a code fence.

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)
```

Value parameters

indexOfStatementInCodeFence

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.

indexOfVariableInStatement

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.

name

the variable name, for example x

runtimeValue

the runtime value of this variable.

staticType

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

totalStatementsInCodeFence

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
```
totalVariablesInStatement

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.

Attributes

Supertypes
class Object
trait Matchable
class Any
Generated with