RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.hugo/com.ossuminc.riddl.hugo.themes/GeekDocGenerator

GeekDocGenerator

com.ossuminc.riddl.hugo.themes.GeekDocGenerator

case class GeekDocGenerator(options: Options, input: PassInput, outputs: PassesOutput, messages: Accumulator) extends ThemeGenerator

Attributes

Source: GeekDocGenerator.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait ThemeGenerator

trait UseCaseDiagramSupport

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source: GeekDocGenerator.scala

Attributes

Source: GeekDocGenerator.scala

Generate a string that contains the name of a definition that is markdown linked to the definition in its source.

Generate a string that contains the name of a definition that is markdown linked to the definition in its source. For example, given sourceURL option of https://github.com/a/b and for an editPath option of src/main/riddl and for a Location that has Org/org.riddl at line 30, we would generate this URL: https://github.com/a/b/blob/main/src/main/riddl/Org/org.riddl#L30 Note that that this works through recursive path identifiers to find the first type that is not a reference Note: this only works for github sources