Package help

Class GHelpBuilder

  • public class GHelpBuilder
extends java.lang.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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void main​(java.lang.String[] args)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GHelpBuilder

        public GHelpBuilder()

    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                 throws java.lang.Exception
        Throws:
        java.lang.Exception