use actual references in javadoc to avoid getting out-of-sync

2026-09-27 10:03:11 +07:00 · 2018-05-04 20:11:52 +03:00
parent f370e25a75
commit 98a768d8a2
27 changed files with 29 additions and 33 deletions
@@ -252,19 +252,19 @@ public abstract class CompilerManager {
                                   @Nullable Runnable onTaskFinished);

  /**
-   * @deprecated Use CompilerTopics.COMPILATION_STATUS
+   * @deprecated Use {@link CompilerTopics#COMPILATION_STATUS} instead
   */
  @Deprecated
  public abstract void addCompilationStatusListener(@NotNull CompilationStatusListener listener);

  /**
-   * @deprecated Use CompilerTopics.COMPILATION_STATUS
+   * @deprecated Use {@link CompilerTopics#COMPILATION_STATUS} instead
   */
  @Deprecated
  public abstract void addCompilationStatusListener(@NotNull CompilationStatusListener listener, @NotNull Disposable parentDisposable);

  /**
-   * @deprecated Use CompilerTopics.COMPILATION_STATUS
+   * @deprecated Use {@link CompilerTopics#COMPILATION_STATUS} instead
   */
  @Deprecated
  public abstract void removeCompilationStatusListener(@NotNull CompilationStatusListener listener);
@@ -80,7 +80,7 @@ public abstract class DaemonCodeAnalyzer {
  }

  /**
-   * @deprecated Please use DaemonListener directly
+   * @deprecated Please use {@link DaemonListener} directly
   */
  public abstract static class DaemonListenerAdapter implements DaemonListener {
    @Override
@@ -47,7 +47,7 @@ public class InspectionProfileLoadUtil {
  }

  /**
-   * @deprecated Please use load(file: Path, ...)
+   * @deprecated Please use {@link #load(Path, InspectionToolRegistrar, InspectionProfileManager)} instead
   */
  @NotNull
  @Deprecated
@@ -16,7 +16,7 @@
 package com.intellij.openapi.editor.event;

 /**
- * @deprecated Use DocumentListener
+ * @deprecated Use {@link DocumentListener} instead
 */
@Deprecated
 public abstract class DocumentAdapter implements DocumentListener {
@@ -26,7 +26,7 @@ import java.util.Map;

 /**
 * @author Roman.Chernyatchik, oleg
- * @deprecated Use GeneralCommandLine instead
+ * @deprecated Use {@link com.intellij.execution.configurations.GeneralCommandLine} instead
 * @deprecated Usages only in Ruby. Move to Ruby module?
 */
@Deprecated
@@ -79,7 +79,7 @@ public class PresentationData implements ColoredItemPresentation, ComparableObje
  }

  /**
-   * @deprecated Use constructor with single icon instead.
+   * @deprecated Use {@link #PresentationData(String, String, Icon, TextAttributesKey)} instead.
   */
  public PresentationData(String presentableText, String locationString, Icon openIcon, Icon closedIcon,
                          @Nullable TextAttributesKey attributesKey) {
@@ -16,7 +16,7 @@
 package com.intellij.openapi.editor.event;

 /**
- * @deprecated Use CaretListener
+ * @deprecated Use {@link CaretListener} instead
 */
@Deprecated
 public abstract class CaretAdapter implements CaretListener {
@@ -24,7 +24,7 @@ import java.awt.*;
@SuppressWarnings("UseJBColor")
 public interface FileStatus {
  /**
-   * @deprecated Use FileStatus.getColor() instead
+   * @deprecated Use {@link FileStatus#getColor} instead
   */
  @Deprecated Color COLOR_NOT_CHANGED = null; // deliberately null, do not use hardcoded Color.BLACK
  @Deprecated Color COLOR_NOT_CHANGED_RECURSIVE = new Color(138, 164, 200);
@@ -50,7 +50,7 @@ public abstract class BeforeRunTask<T extends BeforeRunTask> implements Cloneabl
  }

  /**
-   * @deprecated Use PersistentStateComponent (see LaunchBrowserBeforeRunTask for example).
+   * @deprecated Use {@link PersistentStateComponent} instead (see {@link com.intellij.ide.browsers.LaunchBrowserBeforeRunTask} for example).
   */
  public void writeExternal(@NotNull Element element) {
    if (this instanceof PersistentStateComponent) {
@@ -62,7 +62,7 @@ public abstract class BeforeRunTask<T extends BeforeRunTask> implements Cloneabl
  }

  /**
-   * @deprecated Use PersistentStateComponent (see LaunchBrowserBeforeRunTask for example).
+   * @deprecated Use {@link PersistentStateComponent} instead (see {@link com.intellij.ide.browsers.LaunchBrowserBeforeRunTask} for example).
   */
  public void readExternal(@NotNull Element element) {
    String attribValue = element.getAttributeValue("enabled");
@@ -14,7 +14,7 @@ import org.jetbrains.concurrency.Promise;
 import static com.intellij.execution.runners.GenericProgramRunnerKt.startRunProfile;

 /**
- * @deprecated Use AsyncProgramRunner
+ * @deprecated Use {@link AsyncProgramRunner} instead
 */
@Deprecated
 public abstract class AsyncGenericProgramRunner<Settings extends RunnerSettings> extends BaseProgramRunner<Settings> {
@@ -180,7 +180,7 @@ public class SpacingBuilder {

  /**
   * @param codeStyleSettings
-   * @deprecated Use other constructors!
+   * @deprecated Use {@link #SpacingBuilder(CodeStyleSettings, Language)} or {@link #SpacingBuilder(CommonCodeStyleSettings)} instead
   */
  @SuppressWarnings("unused")
  @Deprecated
@@ -434,7 +434,7 @@ public class CommonCodeStyleSettings {
  public boolean ALIGN_MULTILINE_PARAMETERS_IN_CALLS = false;
  public boolean ALIGN_MULTILINE_RESOURCES = true;
  public boolean ALIGN_MULTILINE_FOR = true;
-  /** @deprecated Use RubyCodeStyleSettings.INDENT_WITH_CASES */
+  /** @deprecated Use {@link org.jetbrains.plugins.ruby.settings.RubyCodeStyleSettings#INDENT_WHEN_CASES} instead */
  @Deprecated
  public boolean INDENT_WHEN_CASES = true;

@@ -16,7 +16,7 @@
 package com.intellij.execution;

 /**
- * @deprecated Please use RunManagerListener directly
+ * @deprecated Please use {@link RunManagerListener} instead
 */
@Deprecated
 public abstract class RunManagerAdapter implements RunManagerListener {
@@ -75,7 +75,7 @@ public abstract class CodeStyleFacade {
  }

  /**
-   * @deprecated Use CodeStyle.getIndentSize(psiFile) instead.
+   * @deprecated Use {@link com.intellij.application.options.CodeStyle#getIndentSize(com.intellij.psi.PsiFile)} instead.
   */
  public abstract int getIndentSize(FileType fileType);

@@ -48,7 +48,7 @@ public interface ApplicationActivationListener {
  }

  /**
-   * @deprecated Use ApplicationActivationListener directly
+   * @deprecated Use {@link ApplicationActivationListener} instead
   */
  @Deprecated
  abstract class Adapter implements ApplicationActivationListener {
@@ -16,7 +16,7 @@
 package com.intellij.openapi.command;

 /**
- * @deprecated Use CommandListener directly
+ * @deprecated Use {@link CommandListener} instead
 */
 public abstract class CommandAdapter implements CommandListener {
 }
@@ -16,7 +16,7 @@
 package com.intellij.openapi.editor.colors;

 /**
- * @deprecated Use EditorColorsListener directly
+ * @deprecated Use {@link EditorColorsListener} instead
 */
@Deprecated
 public abstract class EditorColorsAdapter implements EditorColorsListener {
@@ -185,7 +185,7 @@ public abstract class FileEditorManager {
  /**
   * Adds specified {@code listener}
   * @param listener listener to be added
-   * @deprecated Use MessageBus instead: see {@link FileEditorManagerListener#FILE_EDITOR_MANAGER}
+   * @deprecated Use {@link com.intellij.util.messages.MessageBus} instead: see {@link FileEditorManagerListener#FILE_EDITOR_MANAGER}
   */
  public abstract void addFileEditorManagerListener(@NotNull FileEditorManagerListener listener);

@@ -16,7 +16,7 @@
 package com.intellij.openapi.fileEditor;

 /**
- * @deprecated Please use FileEditorManagerListener
+ * @deprecated Please use {@link FileEditorManagerListener} instead
 */
@Deprecated
 public abstract class FileEditorManagerAdapter implements FileEditorManagerListener {
@@ -16,7 +16,7 @@
 package com.intellij.openapi.project;

 /**
- * @deprecated Use ProjectManagerListener
+ * @deprecated Use {@link ProjectManagerListener} instead
 */
@Deprecated
 public abstract class ProjectManagerAdapter implements ProjectManagerListener {
@@ -18,7 +18,7 @@ package com.intellij.ui.treeStructure;
 import com.intellij.ide.util.treeView.NodeRenderer;

 /**
- * @deprecated Use NodeRenderer instead
+ * @deprecated Use {@link NodeRenderer} instead
 */
 public class SimpleNodeRenderer extends NodeRenderer {

@@ -16,7 +16,7 @@
 package com.intellij.openapi.project;

 /**
- * @deprecated Please use ModuleListener directly.
+ * @deprecated Please use {@link ModuleListener} directly.
 */
 public abstract class ModuleAdapter implements ModuleListener {
 }
@@ -122,7 +122,7 @@ public class JDOMUtil {
  }

  /**
-   * @deprecated Use Element.getChildren() directly
+   * @deprecated Use {@link Element#getChildren} instead
   */
  @NotNull
  @Deprecated
@@ -19,9 +19,8 @@ import com.intellij.util.text.StringFactory;
 import org.jetbrains.annotations.NotNull;

 /**
- * @deprecated Please use java.util.Base64
+ * @deprecated Please use {@link java.util.Base64} instead
 */
-@SuppressWarnings("unused")
@Deprecated
 public class Base64Converter {
  private static final char[] alphabet = {
@@ -59,7 +59,7 @@ public abstract class VcsDirtyScopeManager {
   * Requests an asynchronous file status update for all files under the specified directory.
   *
   * @param dir the directory for which the file status update is requested.
-   * @deprecated Use single-parameter version instead.
+   * @deprecated Use {@link #dirDirtyRecursively(VirtualFile)} instead.
   */
  public abstract void dirDirtyRecursively(VirtualFile dir, final boolean scheduleUpdate);

@@ -26,7 +26,7 @@ import com.intellij.util.ExceptionUtil;
 import org.jetbrains.annotations.NotNull;

 /**
- * @deprecated Use plain {@link ServiceManager#getService(Project, Class)} and {@link Project#getComponent(Class)}.
+ * @deprecated Use {@link ServiceManager#getService(Project, Class)} and {@link Project#getComponent(Class)}.
 * <br/><br/>
 * To avoid "Already Disposed" exceptions and NPEs the calls to getService/getComponent should happen either from a Read Action
 * with a dispose check, or from a background task with a proper dispose-aware ProgressIndicator,
@@ -25,21 +25,18 @@ import org.jetbrains.annotations.NotNull;
 /**
 * @deprecated Use direct instance or ServiceManager methods to access platform structures.
 */
-@SuppressWarnings("DeprecatedIsStillUsed")
@Deprecated
 public interface GitPlatformFacade {

  /**
   * @deprecated To remove in IDEA 2017. Use {@link ChangeListManager#getInstance(Project)}.
   */
-  @SuppressWarnings("unused")
  @Deprecated
  ChangeListManagerEx getChangeListManager(@NotNull Project project);

  /**
   * @deprecated To remove in IDEA 2017. Use {@link VfsUtil#markDirtyAndRefresh(boolean, boolean, boolean, VirtualFile...)}.
   */
-  @SuppressWarnings("unused")
  @Deprecated
  void hardRefresh(@NotNull VirtualFile root);
 }