UserGuideNode (Grace Framework - 2023.3.0)

Summary:
Property
Constructor

| Detail:
Property
Constructor

grails.doc.internal.UserGuideNode

@ToString(excludes: [parent, children])
class UserGuideNode
extends Object

Properties Summary

Properties
Type	Name and description
`List`	`children`
`String`	`file` The location (including filename) of the node, relatively to the root of the gdoc source directory.
`int`	`level` The level of the node
`String`	`name` The identifier for this node.
`UserGuideNode`	`parent`
`String`	`title` The node title, as displayed in the generated user guide.

Constructor Summary

Constructors
Constructor and description
`UserGuideNode()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Property Detail
  - List children
  - String file
    
    The location (including filename) of the node, relatively to the root of the gdoc source directory. Uses Unix style path separators, i.e. '/'/
  - int level
    
    The level of the node
  - String name
    
    The identifier for this node. It's basically the gdoc filename minus the '.gdoc' suffix. Will be null or empty for the root node.
  - UserGuideNode parent
  - String title
    
    The node title, as displayed in the generated user guide.
- Constructor Detail
  - UserGuideNode()

Summary:
Property
Constructor

| Detail:
Property
Constructor