Annotation Type HelpSetRegistration

@Retention(SOURCE) @Target(PACKAGE) public @interface HelpSetRegistration
Registers a help set. A help set reference according to -//NetBeans//DTD JavaHelp Help Set Reference 1.0//EN is created. If the help set specifies a search view, the search indexer will also be run; all *.html and *.htm in the package containing the help set, and its subpackages, will be indexed.
Since:
org.netbeans.modules.javahelp/1 2.20
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    helpSet
    Relative location of a help set file.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    excludes
    Helpset-relative HTML filenames to exclude from indexing.
    boolean
    merge
    Whether the help set should be merged into the master help set.
    int
    position
    Position of help set reference.

  • Element Details

    • helpSet

      String helpSet
      Relative location of a help set file. Typically matches: -//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN

    • merge

      boolean merge
      Whether the help set should be merged into the master help set.
      Default:
      true

    • position

      int position
      Position of help set reference.
      Default:
      2147483647

    • excludes

      String[] excludes
      Helpset-relative HTML filenames to exclude from indexing.
      Default:
      {"credits.html"}