com.ossuminc.riddl.commands.hugo

Members list

Type members

Classlikes

case class GlossaryEntry(term: String, kind: String, brief: String, path: Seq[String], link: String, sourceLink: String)

Attributes

Source
GlossaryPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GlossaryOutput(root: Root, messages: Messages, entries: Seq[GlossaryEntry]) extends CollectingPassOutput[GlossaryEntry]

Attributes

Source
GlossaryPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait PassOutput
class Object
trait Matchable
class Any
Show all
case class GlossaryPass(input: PassInput, outputs: PassesOutput, options: Options)(using x$4: PlatformContext) extends CollectingPass[GlossaryEntry]

Attributes

Companion
object
Source
GlossaryPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Pass
class Object
trait Matchable
class Any
Show all
object GlossaryPass

Attributes

Companion
class
Source
GlossaryPass.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class HugoOutput(root: Root, messages: Messages) extends PassOutput

Attributes

Source
HugoPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait PassOutput
class Object
trait Matchable
class Any
Show all
object HugoPass extends PassInfo[Options]

Attributes

Companion
class
Source
HugoPass.scala
Supertypes
trait PassInfo[Options]
class Object
trait Matchable
class Any
Self type
HugoPass.type
case class HugoPass(input: PassInput, outputs: PassesOutput, options: Options)(using pc: PlatformContext) extends Pass, TranslatingState[MarkdownWriter], Summarizer

Attributes

Companion
object
Source
HugoPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Summarizer
class Pass
class Object
trait Matchable
class Any
Show all
case class MessageInfo(kind: String, message: String, link: String, users: String, description: String)

Information about message types collected by the MessagesPass

Information about message types collected by the MessagesPass

Value parameters

description

Brief description of the message

link

The documentation link to the message type

message

The type of the message - shows the fields of the message, with their brief descriptions if any

users

shows the places from which this message is used with full path identification, and each path component is a link to the documentation for that definition.

Attributes

Source
MessagesPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MessageOutput(root: Root, messages: Messages, collected: Seq[MessageInfo]) extends CollectingPassOutput[MessageInfo]

Attributes

Source
MessagesPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait PassOutput
class Object
trait Matchable
class Any
Show all
case class MessagesPass(input: PassInput, outputs: PassesOutput, options: Options)(using x$4: PlatformContext) extends CollectingPass[MessageInfo]

Attributes

Companion
object
Source
MessagesPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Pass
class Object
trait Matchable
class Any
Show all
object MessagesPass extends PassInfo[Options]

Attributes

Companion
class
Source
MessagesPass.scala
Supertypes
trait PassInfo[Options]
class Object
trait Matchable
class Any
Self type

Attributes

Source
RiddlToHugoTranslator.scala
Supertypes
class Object
trait Matchable
class Any
trait Summarizer(using x$1: PlatformContext)

Attributes

Source
Summarizer.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HugoPass
Self type
case class ToDoItem(item: String, author: String, path: String, link: String)

Attributes

Source
ToDoListPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ToDoListOutput(root: Root, messages: Messages, collected: Seq[ToDoItem]) extends CollectingPassOutput[ToDoItem]

Attributes

Source
ToDoListPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait PassOutput
class Object
trait Matchable
class Any
Show all
case class ToDoListPass(input: PassInput, outputs: PassesOutput, options: Options)(using x$4: PlatformContext) extends CollectingPass[ToDoItem]

Attributes

Companion
object
Source
ToDoListPass.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Pass
class Object
trait Matchable
class Any
Show all
object ToDoListPass extends PassInfo[Options]

Attributes

Companion
class
Source
ToDoListPass.scala
Supertypes
trait PassInfo[Options]
class Object
trait Matchable
class Any
Self type