org.netbeans.modules.java.j2seplatform.spi

Interface J2SEPlatformDefaultJavadoc

public interface J2SEPlatformDefaultJavadoc

Ability to provide default Javadoc for J2SE Platform. The instances registered in the "org-netbeans-api-java/platform/j2seplatform/defaultJavadocProviders" folder are used to provide default Javadoc for J2SE Platforms which have no Javadoc attached by an user. The J2SEPlatformDefaultJavadoc is also consulted by the new java platform wizard when a new J2SE Platform is created to suggest a Javadoc to a newly created platform.

Since:

1.32

Method Summary

Modifier and Type	Method and Description
Collection<URI>	getDefaultJavadoc(JavaPlatform platform) Returns a collection of suggested javadoc roots for given platform.

Method Detail

getDefaultJavadoc

@NonNull
Collection<URI> getDefaultJavadoc(@NonNull
                                           JavaPlatform platform)

Returns a collection of suggested javadoc roots for given platform.

Parameters:

platform - the platform to suggest javadoc for.

Returns:

the suggested javadoc.