Introduction

This document lists changes made to the NetBeans JavaHelp module APIs. Please ask on the [email protected] mailing list if you have any questions.

Index of APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work.

    All changes by date

    Changes by version

    These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line: 

    OpenIDE-Module-Module-Dependencies: org.netbeans.modules.javahelp/1 > 1.20

    Changes by affected class

    org.netbeans.api.javahelp.HelpSetRegistration

    org.netbeans.api.javahelp.HelpUtils

    Details of all changes by API and date

    JavaHelp module APIs

    Added class HelpUtils

    Aug 19 '13; API spec. version: 2.34; affected top-level classes: HelpUtils; made by: jhavlin; issues: #234144

    Provide a method for merging of a custom HelpSet object to the master helpset.

    Added @HelpSetRegistration

    Nov 8 '10; API spec. version: 2.20; affected top-level classes: HelpSetRegistration; made by: jglick; issues: #191452

    There is a new annotation to make it easier to register help sets.


    Compatibility:

    Modules registering help sets in their XML layers are encouraged to migrate to the new annotation. Delete the <helpsetref> file from your layer, move your help set files into the project's regular source/resource root, remove OpenIDE-Module-Requires: org.netbeans.api.javahelp.Help from your module's manifest, add a direct dependency on this module, and add a package-info.java with the annotation. For Ant-based module projects, javahelp.base and javahelp.hs can also be removed from project.properties.

    object tag was added to invoke default IDE HTML Browser to correctly display external links

    May 5 '04; API spec. version: 2.3; made by: mslama; issues: #27892

    Object tag can be used in HTML content to show external link in default IDE HTML browser.


    Compatibility: