diff --git a/platform/lang-api/src/com/intellij/facet/FacetType.java b/platform/lang-api/src/com/intellij/facet/FacetType.java index f664c5420ff5..52ec2a37f680 100644 --- a/platform/lang-api/src/com/intellij/facet/FacetType.java +++ b/platform/lang-api/src/com/intellij/facet/FacetType.java @@ -23,6 +23,7 @@ import javax.swing.*; *   <facetType implementation="qualified-class-name"/> * </extensions> * + * * @author nik */ public abstract class FacetType { @@ -38,12 +39,12 @@ public abstract class FacetType { } /** - * @param id unique instance of {@link FacetTypeId} - * @param stringId unique string id of the facet type - * @param presentableName name of this facet type which will be shown in UI + * @param id unique instance of {@link FacetTypeId} + * @param stringId unique string id of the facet type + * @param presentableName name of this facet type which will be shown in UI * @param underlyingFacetType if this parameter is not {@code null} then you will be able to add facets of this type only as - * subfacets to a facet of the specified type. If this parameter is {@code null} it will be possible to add facet of this type - * directly to a module + * subfacets to a facet of the specified type. If this parameter is {@code null} it will be possible to add facet of this type + * directly to a module */ public FacetType(final @NotNull FacetTypeId id, final @NotNull @NonNls String stringId, final @NotNull String presentableName, final @Nullable FacetTypeId underlyingFacetType) { @@ -54,8 +55,8 @@ public abstract class FacetType { } /** - * @param id unique instance of {@link FacetTypeId} - * @param stringId unique string id of the facet type + * @param id unique instance of {@link FacetTypeId} + * @param stringId unique string id of the facet type * @param presentableName name of this facet type which will be shown in UI */ public FacetType(final @NotNull FacetTypeId id, final @NotNull @NonNls String stringId, final @NotNull String presentableName) { @@ -78,10 +79,10 @@ public abstract class FacetType { } /** - * Default name which will be used then user creates a facet of this type - * @return + * Default name which will be used then user creates a facet of this type. */ - @NotNull @NonNls + @NotNull + @NonNls public String getDefaultFacetName() { return myPresentableName; } @@ -92,24 +93,25 @@ public abstract class FacetType { } /** - * @deprecated this method is not called by IDEA core anymore. Use {@link com.intellij.framework.detection.FrameworkDetector} extension + * @deprecated this method is not called by IDE core anymore. Use {@link com.intellij.framework.detection.FrameworkDetector} extension * to provide automatic detection for facets */ + @SuppressWarnings("unused") @Deprecated public void registerDetectors(FacetDetectorRegistry registry) { } /** - * Create default configuration of facet. See {@link FacetConfiguration} for details - * @return + * Create default configuration of facet. See {@link FacetConfiguration} for details. */ public abstract C createDefaultConfiguration(); /** - * Create a new facet instance - * @param module parent module for facet. Must be passed to {@link Facet} constructor - * @param name name of facet. Must be passed to {@link Facet} constructor - * @param configuration facet configuration. Must be passed to {@link Facet} constructor + * Create a new facet instance. + * + * @param module parent module for facet. Must be passed to {@link Facet} constructor + * @param name name of facet. Must be passed to {@link Facet} constructor + * @param configuration facet configuration. Must be passed to {@link Facet} constructor * @param underlyingFacet underlying facet. Must be passed to {@link Facet} constructor * @return a created facet */ @@ -135,11 +137,12 @@ public abstract class FacetType { } /** - * Returns the topic in the help file which is shown when help for this facet type is requested + * Returns the topic in the help file which is shown when help for this facet type is requested. * * @return the help topic, or null if no help is available. */ - @Nullable @NonNls + @Nullable + @NonNls public String getHelpTopic() { return null; } @@ -150,7 +153,8 @@ public abstract class FacetType { } /** - * Override to allow editing several facets at once + * Override to allow editing several facets at once. + * * @param project project * @param editors editors of selected facets * @return editor