MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

FacetType: javadoc cleanup

Browse Source 
GitOrigin-RevId: 3950eb7c7e58081dc1fc41447768ffb3ac823f93
This commit is contained in:
Yann Cébron
2019-06-05 18:59:15 +03:00
committed by intellij-monorepo-bot
parent 57b86151c3
commit 38d29880a1
1 changed files with 24 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/lang-api/src/com/intellij/facet/FacetType.java
+24 -20
View File
@@ -23,6 +23,7 @@ import javax.swing.*;
*   <facetType implementation="qualified-class-name"/>
* </extensions>
* </pre>
*
* @author nik
*/
public abstract class FacetType<F extends Facet, C extends FacetConfiguration> {
@@ -38,12 +39,12 @@ public abstract class FacetType<F extends Facet, C extends FacetConfiguration> {
}
/**
* @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<F> id, final @NotNull @NonNls String stringId, final @NotNull String presentableName,
final @Nullable FacetTypeId underlyingFacetType) {
@@ -54,8 +55,8 @@ public abstract class FacetType<F extends Facet, C extends FacetConfiguration> {
}
/**
* @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<F> id, final @NotNull @NonNls String stringId, final @NotNull String presentableName) {
@@ -78,10 +79,10 @@ public abstract class FacetType<F extends Facet, C extends FacetConfiguration> {
}
/**
* 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<F extends Facet, C extends FacetConfiguration> {
}
/**
* @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<C> 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<F extends Facet, C extends FacetConfiguration> {
}
/**
* 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<F extends Facet, C extends FacetConfiguration> {
}
/**
* 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