Package help

Class OverlayHelpTree

  • public class OverlayHelpTree
    extends java.lang.Object
    A class that will take in a group of help directories and create a tree of help Table of Contents (TOC) items. Ideally, this tree can be used to create a single TOC document, or individual TOC documents, one for each help directory (this allows for better modularity).

    We call this class an overlay tree to drive home the idea that each help directory's TOC data is put into the tree, with any duplicate paths overlayed on top of those from other help directories.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void printTreeForID​(java.nio.file.Path outputFile, java.lang.String sourceFileID)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • printTreeForID

        public void printTreeForID​(java.nio.file.Path outputFile,
                                   java.lang.String sourceFileID)