Commit b7a78f66 authored by nik's avatar nik
Browse files

javadocs and deprecation

parent cb7fdcdc
Branches unavailable Tags unavailable
No related merge requests found
Showing with 76 additions and 3 deletions
+76 -3
...@@ -17,9 +17,16 @@ ...@@ -17,9 +17,16 @@
package com.intellij.application.options.editor; package com.intellij.application.options.editor;
import com.intellij.openapi.options.UnnamedConfigurable; import com.intellij.openapi.options.UnnamedConfigurable;
import com.intellij.openapi.extensions.ExtensionPointName;
/** /**
* Register implementation of this interface in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;autoImportOptionsProvider instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*
* @author Dmitry Avdeev * @author Dmitry Avdeev
*/ */
public interface AutoImportOptionsProvider extends UnnamedConfigurable { public interface AutoImportOptionsProvider extends UnnamedConfigurable {
......
...@@ -20,8 +20,16 @@ ...@@ -20,8 +20,16 @@
*/ */
package com.intellij.application.options.editor; package com.intellij.application.options.editor;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.options.UnnamedConfigurable; import com.intellij.openapi.options.UnnamedConfigurable;
/**
* Register implementation of this interface in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;codeFoldingOptionsProvider instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*/
public interface CodeFoldingOptionsProvider extends UnnamedConfigurable { public interface CodeFoldingOptionsProvider extends UnnamedConfigurable {
} }
\ No newline at end of file
...@@ -37,6 +37,14 @@ import java.awt.event.ActionListener; ...@@ -37,6 +37,14 @@ import java.awt.event.ActionListener;
import java.util.List; import java.util.List;
/** /**
* To provide an additional settings editor register implementation of {@link com.intellij.openapi.options.UnnamedConfigurable} in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;editorAppearanceConfigurable instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*
* @author yole * @author yole
*/ */
public class EditorAppearanceConfigurable extends CompositeConfigurable<UnnamedConfigurable> implements EditorOptionsProvider { public class EditorAppearanceConfigurable extends CompositeConfigurable<UnnamedConfigurable> implements EditorOptionsProvider {
......
...@@ -22,5 +22,14 @@ package com.intellij.application.options.editor; ...@@ -22,5 +22,14 @@ package com.intellij.application.options.editor;
import com.intellij.openapi.options.SearchableConfigurable; import com.intellij.openapi.options.SearchableConfigurable;
/**
* Register implementation of this interface in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;editorOptionsProvider instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*/
public interface EditorOptionsProvider extends SearchableConfigurable { public interface EditorOptionsProvider extends SearchableConfigurable {
} }
\ No newline at end of file
...@@ -37,6 +37,14 @@ import java.util.Collection; ...@@ -37,6 +37,14 @@ import java.util.Collection;
import java.util.List; import java.util.List;
/** /**
* To provide an additional settings editor register implementation of {@link com.intellij.openapi.options.UnnamedConfigurable} in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;editorSmartKeysConfigurable instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*
* @author yole * @author yole
*/ */
public class EditorSmartKeysConfigurable extends CompositeConfigurable<UnnamedConfigurable> implements EditorOptionsProvider { public class EditorSmartKeysConfigurable extends CompositeConfigurable<UnnamedConfigurable> implements EditorOptionsProvider {
......
...@@ -18,6 +18,14 @@ package com.intellij.openapi.options; ...@@ -18,6 +18,14 @@ package com.intellij.openapi.options;
import com.intellij.openapi.module.Module; import com.intellij.openapi.module.Module;
/** /**
* To provide an additional tab for a module editor register implementation of {@link Configurable} in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;moduleConfigurable instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Project Structure dialog is opened
*
* @author nik * @author nik
*/ */
public class ModuleConfigurableEP extends AbstractConfigurableEP<Configurable> { public class ModuleConfigurableEP extends AbstractConfigurableEP<Configurable> {
......
...@@ -22,5 +22,14 @@ package com.intellij.profile.codeInspection.ui; ...@@ -22,5 +22,14 @@ package com.intellij.profile.codeInspection.ui;
import com.intellij.openapi.options.UnnamedConfigurable; import com.intellij.openapi.options.UnnamedConfigurable;
/**
* Register implementation of this interface in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;errorOptionsProvider instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*/
public interface ErrorOptionsProvider extends UnnamedConfigurable { public interface ErrorOptionsProvider extends UnnamedConfigurable {
} }
\ No newline at end of file
...@@ -18,6 +18,10 @@ package com.intellij.openapi.options; ...@@ -18,6 +18,10 @@ package com.intellij.openapi.options;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
/** /**
* Register implementation of this class as {@code projectConfigurable} or {@code applicationConfigurable} extension to provide items for
* "Project Settings" and "IDE Settings" groups correspondingly in the "Settings" dialog
*
* @see Configurable
* @author nik * @author nik
*/ */
public abstract class ConfigurableProvider { public abstract class ConfigurableProvider {
......
...@@ -27,6 +27,15 @@ import javax.swing.event.ChangeListener; ...@@ -27,6 +27,15 @@ import javax.swing.event.ChangeListener;
import java.awt.*; import java.awt.*;
import java.util.List; import java.util.List;
/**
* To provide an additional settings editor register implementation of {@link com.intellij.openapi.options.SearchableConfigurable} in the plugin.xml:
* <p/>
* &lt;extensions defaultExtensionNs="com.intellij"&gt;<br>
* &nbsp;&nbsp;&lt;generalOptionsProvider instance="class-name"/&gt;<br>
* &lt;/extensions&gt;
* <p>
* A new instance of the specified class will be created each time then the Settings dialog is opened
*/
public class GeneralSettingsConfigurable extends CompositeConfigurable<SearchableConfigurable> implements SearchableConfigurable { public class GeneralSettingsConfigurable extends CompositeConfigurable<SearchableConfigurable> implements SearchableConfigurable {
private static ExtensionPointName<GeneralSettingsConfigurableEP> EP_NAME = ExtensionPointName.create("com.intellij.generalOptionsProvider"); private static ExtensionPointName<GeneralSettingsConfigurableEP> EP_NAME = ExtensionPointName.create("com.intellij.generalOptionsProvider");
......
...@@ -34,7 +34,7 @@ public class AbstractConfigurableEP<T extends UnnamedConfigurable> extends Abstr ...@@ -34,7 +34,7 @@ public class AbstractConfigurableEP<T extends UnnamedConfigurable> extends Abstr
public String instanceClass; public String instanceClass;
/** /**
* @deprecated * @deprecated use '{@link #instanceClass instance}' attribute instead
*/ */
@Attribute("implementation") @Attribute("implementation")
public String implementationClass; public String implementationClass;
......
...@@ -30,6 +30,9 @@ import org.picocontainer.PicoContainer; ...@@ -30,6 +30,9 @@ import org.picocontainer.PicoContainer;
* @author nik * @author nik
*/ */
public class ConfigurableEP extends AbstractExtensionPointBean { public class ConfigurableEP extends AbstractExtensionPointBean {
/**
* @deprecated use '{@link #instanceClass instance}' or '{@link #providerClass provider}' attribute instead
*/
@Attribute("implementation") @Attribute("implementation")
public String implementationClass; public String implementationClass;
@Attribute("instance") @Attribute("instance")
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment