class DocTableRow

Class representing all information within a documentation table row.

attribute indent

Returns an Indent object. The object has attributes to get the indent/level of the data structure element as:

  • HTML/Markdown encoded
  • String/nice YAML encoded

attribute variable

Returns a Variable object. The object has attributes to get the variable name of the data structure element as:

  • HTML/Markdown encoded (including indent)
  • Nice YAML encoded (including indent)
  • String (without indent)

attribute path

Returns a str containing the path with the data structure to this element.

attribute type

Returns a Type object. The object has attributes to get the type(s) of the data structure element as:

  • HTML/Markdown encoded
  • Nice YAML encoded (as an abbrevation, if appropriate)
  • String

attribute restrictions

Returns a TextField object. The object has attributes to get the restrictions of the data structure element as:

  • HTML/Markdown encoded
  • Multiline string

attribute description

Returns a TextField object. The object has attributes to get the restrictions of the data structure element as:

  • HTML/Markdown encoded
  • Multiline string