RIDDL API Documentation
0.0.0-1-1f99f002
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.hugo/com.ossuminc.riddl.hugo.writers/MarkdownBasics

MarkdownBasics

com.ossuminc.riddl.hugo.writers.MarkdownBasics
trait MarkdownBasics extends TextFileWriter, ThemeWriter

Attributes

Source
MarkdownBasics.scala
Graph
Supertypes
trait ThemeWriter
trait OutputFile
trait FileBuilder
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type

Members list

Value members

Concrete methods

def bold(phrase: String): String

Attributes

Source
MarkdownBasics.scala
def h1(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def h2(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def h3(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def h4(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def h5(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def h6(heading: String): this.type

Attributes

Source
MarkdownBasics.scala
def heading(heading: String, level: Int): this.type

Attributes

Source
MarkdownBasics.scala
def italic(phrase: String): String

Attributes

Source
MarkdownBasics.scala
def list[T](items: Seq[T]): Unit

Attributes

Source
MarkdownBasics.scala
def list[T](typeOfThing: String, items: Seq[T], level: Int): Unit

Attributes

Source
MarkdownBasics.scala
def listOf[T <: Definition](kind: String, items: Seq[T], level: Int): Unit

Attributes

Source
MarkdownBasics.scala
def mono(phrase: String): String

Attributes

Source
MarkdownBasics.scala
def p(paragraph: String): this.type

Attributes

Source
MarkdownBasics.scala
protected def tbd(definition: Definition): Unit

Attributes

Source
MarkdownBasics.scala

Inherited methods

def add(str: String): FileBuilder.this.type

Append a string without indent or suffix

Append a string without indent or suffix

Value parameters

str

The string to append

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(line: String): FileBuilder.this.type

Append an indented line with newline at the end and a level width indent prefix.

Append an indented line with newline at the end and a level width indent prefix. The indent will be done with level * spaces-per-level space characters.

Value parameters

line

The text of the line to be indented

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(): FileBuilder.this.type

Add just the indent spaces

Add just the indent spaces

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addLine(line: String): FileBuilder.this.type

Append a line to the buffer with a terminating newline.

Append a line to the buffer with a terminating newline. No prefix is inserted

Value parameters

line

The line to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def append(text: String): FileBuilder.this.type

Append a line to the buffer without newlines or indentation

Append a line to the buffer without newlines or indentation

Value parameters

text

The text to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def clear(): Unit

Completely erase the internal buffer

Completely erase the internal buffer

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
def decr: FileBuilder.this.type

Decrement the indent by one level

Decrement the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
def incr: FileBuilder.this.type

Increment the indent by one level

Increment the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
def nl: FileBuilder.this.type

Append a newline character

Append a newline character

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
protected def spc: String

The number of spaces at the current indent level

The number of spaces at the current indent level

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
def toLines: Seq[String]

Convert the buffer to a sequence of strings, one line per string

Convert the buffer to a sequence of strings, one line per string

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
FileBuilder -> Any
Inherited from:
FileBuilder
Source
FileBuilder.scala
def write(): Unit

Attributes

Inherited from:
OutputFile
Source
OutputFile.scala
def write(writer: PrintWriter): Unit

Attributes

Inherited from:
OutputFile
Source
OutputFile.scala

Inherited and Abstract methods

def codeBlock(items: Seq[Statements]): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def containerHead(cont: Parent): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def emitMermaidDiagram(lines: Seq[String]): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def fileHead(title: String, weight: Int, desc: Option[String], extras: Map[String, String]): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def filePath: Path

Attributes

Inherited from:
OutputFile
Source
OutputFile.scala
def leafHead(definition: LeafDefinition, weight: Int): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def notAvailable(thing: String, title: String): Unit

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala
def themeName: String

Attributes

Inherited from:
ThemeWriter
Source
ThemeWriter.scala

Concrete fields

protected val containerWeight: Int

Attributes

Source
MarkdownBasics.scala

Inherited fields

protected val new_line: String

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
protected val spaces_per_level: Int

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.