SJSD.Parser.DocNode

The DocNode hash represents the JSON structure after parsing a comment block.

Properties

children
List of nodes which have been calculated as being children of this node
hasEntityChildren
Whether the node has children which are of the "entity" type
hasFunctionChildren
Whether the node has children which are of the "function" type
hasModuleChildren
Whether the node has children which are of the "module" type
hasNamespaceChildren
Whether the node has children which are of the "namespace" type
hasPropertyChildren
Whether the node has children which are of the "property" type
memberof
A text indication of what node is this node's parent
params
A list of all the @param modifiers
paramsAsString
A (joined) string representation of all the parameters
qualifiedName
This is the main global identifier for the node
raw
The raw text of the comment block as it looked before parse
rawModifiers
A list of what modifiers were found
shortDesc
The short description to use in lists
text
The text content of the comment block once modifiers have been removed
type
The base type of the node