GhidraHelpService

java.lang.Object

docking.help.HelpManager

ghidra.base.help.GhidraHelpService

All Implemented Interfaces:: HelpService

public class GhidraHelpService extends HelpManager

Ghidra's help service. This class knows how to find help for the various modules that make up Ghidra.

Field Summary

Fields inherited from class docking.help.HelpManager
SHOW_AID_KEY

Fields inherited from interface help.HelpService
DUMMY_HELP_SET_NAME
Method Summary

Modifier and Type

Method

Description

protected String

getHomeId()

Returns the 'home id' to be used by all help sets in the system (as opposed to allowing each help set to define its own home id.

static void

install()

Methods inherited from class docking.help.HelpManager
addHelpSet, clearHelp, excludeFromHelp, getHelpLocation, getInvalidHelpLocations, getMasterHelpSet, helpExists, isExcludedFromHelp, mergePendingHelpSets, registerHelp, registerHelp, reload, showHelp, showHelp, showHelp

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- install
  
  public static void install()
- getHomeId
  
  protected String getHomeId()
  
  Description copied from class: HelpManager
  
  Returns the 'home id' to be used by all help sets in the system (as opposed to allowing each help set to define its own home id.
  
  Overrides:
  
  getHomeId in class HelpManager
  
  Returns:
  
  the home id