From f35e6e904540ccd1217d368a4a76c5208e49fade Mon Sep 17 00:00:00 2001 From: Sergey Malenkov Date: Wed, 8 Apr 2015 18:00:50 +0300 Subject: [PATCH] IDEA-132304 Update com.intellij.openapi.options.Configurable java doc with links to ConfigurableEP --- .../openapi/options/Configurable.java | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/platform/platform-api/src/com/intellij/openapi/options/Configurable.java b/platform/platform-api/src/com/intellij/openapi/options/Configurable.java index 5f7c5c9b99e1..935ec4ba0125 100644 --- a/platform/platform-api/src/com/intellij/openapi/options/Configurable.java +++ b/platform/platform-api/src/com/intellij/openapi/options/Configurable.java @@ -34,41 +34,41 @@ import org.jetbrains.annotations.Nullable; *

* The following attributes are available for both extension points mentioned above: *

- *
{@code instance}
+ *
{@link ConfigurableEP#instanceClass instance}
*
This attribute specifies a qualified name of a custom implementation of this interface. * The constructor will be determined automatically from the tag name: *
{@code } *
{@code     } *
{@code }
- *
{@code provider}
+ *
{@link ConfigurableEP#providerClass provider}
*
This attribute can be used instead of the {@code instance} attribute. * It specifies a qualified name of a custom implementation of the {@link ConfigurableProvider} interface, * which provides another way to create a configurable component: *
{@code } *
{@code     } *
{@code }
- *
{@code implementation}
+ *
{@link ConfigurableEP#implementationClass implementation}
*
This attribute is deprecated and replaced with two attributes above. * In fact, it works as the {@code instance} attribute.
- *
{@code nonDefaultProject}
+ *
{@link ConfigurableEP#nonDefaultProject nonDefaultProject}
*
This attribute is applicable to the {@code projectConfigurable} extension only. * If it is set to {@code true}, the corresponding project settings will be shown for a real project only, * not for the {@link com.intellij.openapi.project.ProjectManager#getDefaultProject() template project}, * which provides default settings for all the new projects.
- *
{@code displayName}
+ *
{@link ConfigurableEP#displayName displayName}
*
This attribute specifies the setting name visible to users. * If the display name is not set, a configurable component will be instantiated to retrieve its name dynamically. * This causes a loading of plugin classes and increases the delay before showing the settings dialog. * It is highly recommended specifying the display name in XML to improve UI responsiveness.
- *
{@code key} and {@code bundle}
+ *
{@link ConfigurableEP#key key} and {@link ConfigurableEP#bundle bundle}
*
These attributes specify the display name too, if the specified key is declared in the specified resource bundle.
- *
{@code id}
+ *
{@link ConfigurableEP#id id}
*
This attribute specifies the {@link SearchableConfigurable#getId() unique identifier} * for the configurable component. It is also recommended specifying the identifier in XML.
- *
{@code parentId}
+ *
{@link ConfigurableEP#parentId parentId}
*
This attribute is used to create a hierarchy of settings. * If it is set, the configurable component will be a child of the specified parent component.
- *
{@code groupId}
+ *
{@link ConfigurableEP#groupId groupId}
*
This attribute specifies a top-level group, which the configurable component belongs to. * If this attribute is not set, the configurable component will be added to the Other Settings group. * The following groups are supported: @@ -102,18 +102,18 @@ import org.jetbrains.annotations.Nullable; *
* The {@code parentId} and the {@code groupId} attributes should not be used together and the {@code parentId} has precedence. * Currently, it is possible to specify a group identifier in the {@code parentId} attribute. - *
{@code groupWeight}
+ *
{@link ConfigurableEP#groupWeight groupWeight}
*
This attribute specifies the weight of a configurable component within a group or a parent configurable component. * The default weight is {@code 0}. If one child in a group or a parent configurable component has non-zero weight, * all children will be sorted descending by their weight. And if the weights are equal, * the components will be sorted ascending by their display name.
- *
{@code dynamic}
+ *
{@link ConfigurableEP#dynamic dynamic}
*
This attribute states that a custom configurable component implements the {@link Composite} interface * and its children are dynamically calculated by calling the {@code getConfigurables} method. * It is needed to improve performance, because we do not want to load any additional classes during the building a setting tree.
- *
{@code childrenEPName}
+ *
{@link ConfigurableEP#childrenEPName childrenEPName}
*
This attribute specifies a name of the extension point that will be used to calculate children.
- *
{@code configurable}
+ *
{@link ConfigurableEP#children configurable}
*
This is not an attribute, this is an inner tag. It specifies children directly in the main tag body. For example, *
{@code } *
{@code     } @@ -123,6 +123,7 @@ import org.jetbrains.annotations.Nullable; *
{@code }
* * + * @see ConfigurableEP * @see SearchableConfigurable */ public interface Configurable extends UnnamedConfigurable {