Package help

# Class GHelpBuilder

java.lang.Object
help.GHelpBuilder

public class GHelpBuilder extends Object
A class to build help for an entire 'G' application. This class will take in a list of module paths and build the help for each module. To build single modules, call this class with only one module path.

Note: Help links must not be absolute. They can be relative, including `. and ..` syntax. Further, they can use the special help system syntax, which is:

- `help/topics/topicName/Filename.html` for referencing help topic files
- `help/shared/image.png` for referencing image files at paths rooted under the module's root help dir

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `GHelpBuilder()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static void`
  `main(String[] args)`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### GHelpBuilder

    public GHelpBuilder()

- ## Method Details

  - ### main

    public static void main(String[] args) throws Exception
    Throws:
      `Exception`