HelpSetRegistration (JavaHelp Integration)

Skip navigation links

org.netbeans.modules.javahelp/1 2.40.1

All Classes

SEARCH:

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@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:

how to convert to this annotation

Required Element Summary

Required Elements
Modifier and Type Required Element Description

java.lang.String helpSet
Relative location of a help set file.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`java.lang.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 Detail
  - helpSet
```
java.lang.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
```
java.lang.String[] excludes
```
    Helpset-relative HTML filenames to exclude from indexing.
    
    Default:
    
    {"credits.html"}

Skip navigation links

org.netbeans.modules.javahelp/1 2.40.1

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

Built on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.