RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.hugo/MarkdownWriter

MarkdownWriter

com.reactific.riddl.hugo.MarkdownWriter
case class MarkdownWriter(filePath: Path, state: HugoTranslatorState) extends TextFileWriter

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait OutputFile
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def codeBlock(headline: String, items: Seq[Statement], level: Int): MarkdownWriter.this.type
def emitAdaptor(adaptor: Adaptor, parents: Seq[String]): MarkdownWriter.this.type
def emitApplication(application: Application, stack: Seq[Definition]): MarkdownWriter.this.type
def emitAuthorInfo(authors: Seq[Author], level: Int): MarkdownWriter.this.type
def emitBriefly(d: Definition, parents: Seq[String], level: Int): MarkdownWriter.this.type
def emitC4ContainerDiagram(defntn: Context, parents: Seq[Definition]): MarkdownWriter.this.type
def emitConnection(conn: Connector, parents: Seq[String]): MarkdownWriter.this.type
def emitContext(context: Context, stack: Seq[Definition]): MarkdownWriter.this.type
def emitContextMap(focus: Context, parents: Seq[Definition]): MarkdownWriter.this.type
def emitDefDoc(definition: Definition, parents: Seq[String], level: Int): MarkdownWriter.this.type
def emitDescription(d: Option[Description], level: Int): MarkdownWriter.this.type
def emitDomain(domain: Domain, parents: Seq[String]): MarkdownWriter.this.type
def emitERD(name: String, fields: Seq[Field], parents: Seq[Definition]): MarkdownWriter.this.type
def emitEntity(entity: Entity, parents: Seq[String]): MarkdownWriter.this.type
def emitEpic(epic: Epic, stack: Seq[Definition]): MarkdownWriter.this.type
def emitFields(fields: Seq[Field]): MarkdownWriter.this.type
def emitFiniteStateMachine(entity: Entity): MarkdownWriter.this.type
def emitFunction(function: Function, parents: Seq[String]): MarkdownWriter.this.type
def emitGlossary(weight: Int, terms: Seq[GlossaryEntry]): MarkdownWriter.this.type
def emitHandler(handler: Handler, parents: Seq[String]): MarkdownWriter.this.type
def emitIndex(kind: String, top: Definition, parents: Seq[String]): MarkdownWriter.this.type
def emitInvariants(invariants: Seq[Invariant]): MarkdownWriter.this.type
def emitMermaidDiagram(lines: Seq[String]): MarkdownWriter.this.type
def emitOptions[OT <: OptionValue](options: Seq[OT], level: Int): MarkdownWriter.this.type
def emitProjection(projection: Projector, parents: Seq[String]): MarkdownWriter.this.type
def emitSaga(saga: Saga, parents: Seq[String]): MarkdownWriter.this.type
def emitSagaSteps(actions: Seq[SagaStep]): MarkdownWriter.this.type
def emitShortDefDoc(definition: Definition): MarkdownWriter.this.type
def emitState(state: State, fields: Seq[Field], parents: Seq[Definition]): MarkdownWriter.this.type
def emitStatistics(weight: Int, root: RootContainer): MarkdownWriter.this.type
def emitStreamlet(proc: Streamlet, parents: Seq[Definition]): MarkdownWriter.this.type
def emitTableHead(columnTitles: Seq[(String, Char)]): MarkdownWriter.this.type
def emitTableRow(firstCol: String, remainingCols: String*): MarkdownWriter.this.type
def emitTerms(terms: Seq[Term]): MarkdownWriter.this.type
def emitToDoList(weight: Int, map: Map[String, Seq[String]]): Unit
def emitType(typ: Type, stack: Seq[Definition]): MarkdownWriter.this.type
def emitTypeExpression(typeEx: TypeExpression, parents: Seq[Definition], headLevel: Int): MarkdownWriter.this.type
def emitTypesToc(definition: WithTypes): MarkdownWriter.this.type
def emitUsage(definition: Definition): MarkdownWriter.this.type
def emitUseCase(uc: UseCase, parents: Seq[Definition]): MarkdownWriter.this.type
def fileHead(title: String, weight: Int, desc: Option[String], extras: Map[String, String]): MarkdownWriter.this.type
def h1(heading: String): MarkdownWriter.this.type
def h2(heading: String): MarkdownWriter.this.type
def h3(heading: String): MarkdownWriter.this.type
def h4(heading: String): MarkdownWriter.this.type
def h5(heading: String): MarkdownWriter.this.type
def h6(heading: String): MarkdownWriter.this.type
def heading(heading: String, level: Int): MarkdownWriter.this.type
def list[T](items: Seq[T]): MarkdownWriter.this.type
def list[T](typeOfThing: String, items: Seq[T], level: Int): MarkdownWriter.this.type
def listOf[T <: Definition](kind: String, items: Seq[T], level: Int): MarkdownWriter.this.type
def makeERDRelationship(from: String, to: Field, parents: Seq[Definition]): String
def p(paragraph: String): MarkdownWriter.this.type
def toc(kindOfThing: String, contents: Seq[String], level: Int): MarkdownWriter.this.type

Inherited methods

def clear: Unit

Attributes

Inherited from:
FileBuilder
def nl: FileBuilder.this.type

Attributes

Inherited from:
FileBuilder
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def toLines: Seq[String]

Attributes

Inherited from:
FileBuilder
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
Inherited from:
TextFileWriter
def write(): Unit

Attributes

Inherited from:
OutputFile
def write(writer: PrintWriter): Unit

Attributes

Inherited from:
OutputFile

Inherited fields

val newLine: String

Attributes

Inherited from:
FileBuilder
protected val sb: StringBuilder

Attributes

Inherited from:
FileBuilder
Generated with