Package help.validator.location

Class DirectoryHelpModuleLocation

java.lang.Object

help.validator.location.HelpModuleLocation

help.validator.location.DirectoryHelpModuleLocation

Direct Known Subclasses:

GeneratedDirectoryHelpModuleLocation

public class DirectoryHelpModuleLocation
extends HelpModuleLocation

Field Summary

Fields inherited from class help.validator.location.HelpModuleLocation

helpDir, sourceTOCFile

Constructor Summary

Constructors

Constructor	Description
DirectoryHelpModuleLocation(File file)

Method Summary

Modifier and Type	Method	Description
boolean	isHelpInputSource()	Returns true if this help location represents a source of input files to generate help output
javax.help.HelpSet	loadHelpSet()
GhidraTOCFile	loadSourceTOCFile()

Methods inherited from class help.validator.location.HelpModuleLocation

getAllHREFs, getAllIMGs, getHelpLocation, getHelpModuleLocation, getHelpTopics, getModuleRepoRoot, loadHelpTopics, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryHelpModuleLocation

public DirectoryHelpModuleLocation(File file)

Method Details

isHelpInputSource

public boolean isHelpInputSource()

Description copied from class: HelpModuleLocation

Returns true if this help location represents a source of input files to generate help output

Specified by:

isHelpInputSource in class HelpModuleLocation

Returns:

true if this help location represents a source of input files to generate help output

loadHelpSet

public javax.help.HelpSet loadHelpSet()

Specified by:

loadHelpSet in class HelpModuleLocation

loadSourceTOCFile

public GhidraTOCFile loadSourceTOCFile()

Specified by:

loadSourceTOCFile in class HelpModuleLocation