RIDDL API Documentation
0.0.0-1-403b318f
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.commands/com.ossuminc.riddl.commands.hugo/com.ossuminc.riddl.commands.hugo.themes/GeekDocWriter

GeekDocWriter

com.ossuminc.riddl.commands.hugo.themes.GeekDocWriter
See theGeekDocWriter companion object
case class GeekDocWriter(filePath: Path, input: PassInput, outputs: PassesOutput, options: Options)(using pc: PlatformContext) extends MarkdownWriter

Theme extension to the MardownWriter for the Hugo GeekDoc theme

Attributes

Companion
object
Source
GeekDocWriter.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait ModuleWriter
trait SagaWriter
trait DomainWriter
trait ThemeWriter
trait EpicWriter
trait EntityWriter
trait OutputFile
trait FileBuilder
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

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

Attributes

Source
GeekDocWriter.scala
def containerHead(cont: Parent): Unit

Attributes

Source
GeekDocWriter.scala
def emitMermaidDiagram(lines: Seq[String]): Unit

Attributes

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

Attributes

Source
GeekDocWriter.scala
def leafHead(definition: LeafDefinition, weight: Int): Unit

Attributes

Source
GeekDocWriter.scala
def notAvailable(thing: String, title: String): Unit

Attributes

Source
GeekDocWriter.scala
def processorIndex(processor: Processor[_]): Unit

Attributes

Source
GeekDocWriter.scala
def themeName: String

Attributes

Source
GeekDocWriter.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 bold(phrase: String): String

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.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 definitionToc(kindOfThing: String, list: Seq[Definition], level: Int): Unit

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def emitAdaptor(adaptor: Adaptor, parents: Parents): Unit

Attributes

Inherited from:
AdaptorWriter
Source
AdaptorWriter.scala
protected def emitAuthorInfo(authors: Seq[Author], level: Int): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitAuthors(weight: Int, authors: Seq[Author]): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
def emitC4ContainerDiagram(definition: Context, parents: Parents): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitConnector(conn: Connector, parents: Parents): Unit

Attributes

Inherited from:
StreamletWriter
Source
StreamletWriter.scala
def emitContext(context: Context, parents: Parents): Unit

Attributes

Inherited from:
ContextWriter
Source
ContextWriter.scala
protected def emitDefDoc(definition: Definition, parents: Parents, level: Int): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitDescriptions(descriptions: Seq[Description], level: Int): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitDomain(domain: Domain, parents: Parents): Unit

Attributes

Inherited from:
DomainWriter
Source
DomainWriter.scala
def emitEntity(entity: Entity, parents: Parents): Unit

Attributes

Inherited from:
EntityWriter
Source
EntityWriter.scala
def emitEpic(epic: Epic, parents: Parents): Unit

Attributes

Inherited from:
EpicWriter
Source
EpicWriter.scala
protected def emitFields(fields: Seq[Field]): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitFunction(function: Function, parents: Parents): Unit

Attributes

Inherited from:
FunctionWriter
Source
FunctionWriter.scala
def emitGlossary(weight: Int, terms: Seq[GlossaryEntry]): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
def emitHandler(handler: Handler, parents: Parents, level: Int): Unit

Attributes

Inherited from:
EntityWriter
Source
EntityWriter.scala
protected def emitInlets(inlets: Seq[Inlet], parents: Parents): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def emitInputOutput(input: Option[Aggregation], output: Option[Aggregation]): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def emitInvariants(invariants: Seq[Invariant]): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitMessageSummary(domain: Domain, messages: Seq[MessageInfo], kind: String): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
def emitModule(module: Module, parents: Parents): Unit

Attributes

Inherited from:
ModuleWriter
Source
ModuleWriter.scala
protected def emitOptions[OT <: OptionValue](options: Seq[OT], level: Int): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def emitOutlets(outlets: Seq[Outlet], parents: Parents): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def emitProcessorDetails[CT <: RiddlValue](processor: Processor[CT], stack: Parents): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitProjector(projector: Projector, parents: Parents): Unit

Attributes

Inherited from:
ProjectorWriter
Source
ProjectorWriter.scala
def emitRepository(repository: Repository, parents: Parents): Unit

Attributes

Inherited from:
RepositoryWriter
Source
RepositoryWriter.scala
def emitSaga(saga: Saga, parents: Parents): Unit

Attributes

Inherited from:
SagaWriter
Source
SagaWriter.scala
def emitSchema(repository: Repository): Unit

Attributes

Inherited from:
RepositoryWriter
Source
RepositoryWriter.scala
protected def emitShortDefDoc(definition: Definition): MarkdownWriter.this.type

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitStatistics(weight: Int): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
def emitStreamlet(streamlet: Streamlet, parents: Parents): Unit

Attributes

Inherited from:
StreamletWriter
Source
StreamletWriter.scala
def emitTableHead(columnTitles: Seq[(String, Char)]): Unit

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def emitTableRow(firstCol: String, remainingCols: String*): Unit

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def emitTerms(terms: Seq[Term]): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitToDoList(weight: Int, items: Seq[ToDoItem]): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
protected def emitTypes(types: Seq[Type], parents: Parents, level: Int): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def emitUseCase(uc: UseCase, parents: Parents): Unit

Attributes

Inherited from:
EpicWriter
Source
EpicWriter.scala
def emitUser(u: User, parents: Parents): EpicWriter.this.type

Attributes

Inherited from:
EpicWriter
Source
EpicWriter.scala
def emitUsers(weight: Int, users: Seq[User]): Unit

Attributes

Inherited from:
SummariesWriter
Source
SummariesWriter.scala
protected def emitVitalDefTable(definition: Definition, parents: Parents): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def emitVitalDefinitionDetails[CT <: RiddlValue](vd: VitalDefinition[CT], stack: Parents): Unit

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.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 italic(phrase: String): String

Attributes

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

Attributes

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

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def listDesc(maybeDescription: Option[Description], isListItem: Boolean, indent: Int): Unit

Attributes

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

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def makeRootIndex(root: Root, indent: Int): Unit

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
protected def makeTypeName(typeEx: TypeExpression, parents: Parents): String

Attributes

Inherited from:
MarkdownWriter
Source
MarkdownWriter.scala
def mono(phrase: String): String

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.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
def p(paragraph: String): MarkdownBasics.this.type

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
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
protected def tbd(definition: Definition): Unit

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.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 toc(kindOfThing: String, contents: Seq[String], level: Int): Unit

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
def write(): Unit

Attributes

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

Attributes

Inherited from:
OutputFile
Source
OutputFile.scala

Concrete fields

val geekDoc_url: URL

Attributes

Source
GeekDocWriter.scala

Inherited fields

protected val containerWeight: Int

Attributes

Inherited from:
MarkdownBasics
Source
MarkdownBasics.scala
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.