HugoTranslatorState
The processing state for the Hugo Translator
Value parameters
- commonOptions
-
The common options all commands use
- options
-
The options specific to Hugo Translator
- root
-
RootContainer that was parsed
- symbolTable
-
A symbolTable for the names of things
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait TranslatingState[MarkdownWriter]class Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Generate a string that is the file path portion of a url including the line number.
Generate a string that is the file path portion of a url including the line number.
Attributes
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
Value parameters
- definition
-
The definition for which we want the link
Attributes
- Returns
-
a string that gives the source link for the definition
Inherited methods
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Concrete fields
Inherited fields
Attributes
- Inherited from:
- TranslatingState
Attributes
- Inherited from:
- TranslatingState