Skip to main content
Version: v0.17.0

DocumentationCreate

Alias:DocumentationCreate, DocGen, GenerateDocumentation

Output:Entity

Generates documentation for all available steps.

ParameterTypeRequiredPositionDefault ValueSummary
RootUrlstring1Empty StringRoot URL of all links in the documentation. You should include a slash / at the end.

Examples

Example 1

Logs all the file paths

SCL

- <root> = 'sequence/steps'
- (DocumentationCreate)['AllPages'] | ForEach (
- <path> = $"{<root>}/{<>['Directory']}/{<>['FileName']}"
- log <path>
)

Example 2

SCL

GenerateDocumentation | EntityFormat

Expected Output

(
'MainContents': (
'PageType': "Contents"
'FileName': "all.md"
'Title': "all"
'FileText': "..."
'Directory': null
)
'Categories': [
(
'CategoryContents': (
'Category': "Core"
'PageType': "Contents"
'FileName': "Core.md"
'Title': "Core"
'FileText': "..."
'Directory': null
)
'Steps': [
(
'Category': "Core"
'StepName': "And"
'Aliases': ["And"]
'Summary': null
'ReturnType': "Boolean"
'StepParameters': [
(
'Name': "Terms"
'Type': "Array<bool>"
'Summary': null
'Required': True
'Aliases': null
)
]
'PageType': "Step"
'FileName': "And.md"
'Title': "And"
'FileText': ".."
'Directory': "Core"
),
...
]
),
...
]
'Enums': [
(
'Values': [
('Name': "Default" Summary: "The default encoding."),
('Name': "Ascii" Summary: "Ascii"),
('Name': "BigEndianUnicode" Summary: "Unicode with big-endian byte order"),
('Name': "UTF8" Summary: "UTF8 with no byte order mark."),
('Name': "UTF8BOM" Summary: "UTF8 with byte order mark."),
('Name': "UTF32" Summary: "UTF32"),
('Name': "Unicode" Summary: "Unicode with little-endian byte order")
]
'PageType': "Enums"
'FileName': "EncodingEnum.md"
'Title': "EncodingEnum"
'FileText': ""
Directory: ""
),
...
]
'AllPages': [
(
'PageType': "Contents"
'FileName': "all.md"
'Title': "all"
'FileText': "..."
'Directory': null
),
(
'Category': "Core"
'PageType': "Contents"
'FileName': "Core.md"
'Title': "Core"
'FileText': "..."
'Directory': null
),
...
]
)

Example 3

SCL

log (stringContains (DocumentationCreate RootUrl: 'MyRoot').MainContents.FileText 'MyRoot/Core/And.md')

Expected Logs

True