roboliq-processor

Module: generateSchemaDocs

Generate documentation from the schemas in schemas/*.yaml. Running this module will create these files:

  • tutorials/Object_Types.md
  • tutorials/Commands.md
Source:

Methods

<inner> commandToJsdoc(pair)

Convert a name/schema pair to markdown text.

Parameters:
Name Type Description
pair array

[name, schema]
Source:
Returns:

A markdown string.

<inner> indentJsdocComment(s)

Take a string, split it on all newlines, prepend each newline with " * ", and then rejoin.

Parameters:
Name Type Description
s string

string to indent
Source:
Returns:
  • string indented by " * "
Type
string

<inner> toMarkdown(pair)

Convert a name/schema pair to markdown text.

Parameters:
Name Type Description
pair array

[name, schema]
Source:
Returns:

A markdown string.

<inner> typeToJsdoc(pair, isCommand)

Convert a name/schema pair to jsdoc text.

Parameters:
Name Type Default Description
pair array

[name, schema]
isCommand boolean false

true if pair is a command, in which case the memberOf field is handled differently.
Source:
Returns:

A markdown string.