Fix incorrect usages of Javadoc syntax {@code} and {@link} in various

Java classes.

Reviewed-by: Tagir Valeev <tagir.valeev@jetbrains.com>
PR#2520

GitOrigin-RevId: 2ace377ae2dc38b0cfe0a73bf43ac84a067b3071
This commit is contained in:
Andrei Rybak
2024-05-16 11:06:04 +02:00
committed by intellij-monorepo-bot
parent 18e26f108f
commit 26d8b55820
10 changed files with 10 additions and 10 deletions

View File

@@ -70,7 +70,7 @@ public interface CompileScope extends ExportableUserDataHolder {
} }
/** /**
* @return similar to {getAffectedModules}, but is more precise about which kinds of source roots are affected: production and/or tests * @return similar to {@link #getAffectedModules}, but is more precise about which kinds of source roots are affected: production and/or tests
*/ */
default Collection<ModuleSourceSet> getAffectedSourceSets() { default Collection<ModuleSourceSet> getAffectedSourceSets() {
List<ModuleSourceSet> sets = new SmartList<>(); List<ModuleSourceSet> sets = new SmartList<>();

View File

@@ -51,7 +51,7 @@ public interface UnresolvedReferenceQuickFixUpdater {
void waitQuickFixesSynchronously(@NotNull PsiFile file, @NotNull Editor editor, @NotNull List<? extends HighlightInfo> infos); void waitQuickFixesSynchronously(@NotNull PsiFile file, @NotNull Editor editor, @NotNull List<? extends HighlightInfo> infos);
/** /**
* Start background computation of quick fixes for unresolved references in the {code file} at the current caret offset * Start background computation of quick fixes for unresolved references in the {@code file} at the current caret offset
*/ */
void startComputingNextQuickFixes(@NotNull PsiFile file, @NotNull Editor editor, @NotNull ProperTextRange visibleRange); void startComputingNextQuickFixes(@NotNull PsiFile file, @NotNull Editor editor, @NotNull ProperTextRange visibleRange);
} }

View File

@@ -60,7 +60,7 @@ public abstract class BigPopupUI extends BorderLayoutPanel implements Disposable
protected abstract ListCellRenderer<Object> createCellRenderer(); protected abstract ListCellRenderer<Object> createCellRenderer();
/** /**
* todo make the method abstract after {@link #createTopLeftPanel()} and {link {@link #createSettingsPanel()}} are removed * todo make the method abstract after {@link #createTopLeftPanel()} and {@link #createSettingsPanel()} are removed
*/ */
@NotNull @NotNull
protected JComponent createHeader() { protected JComponent createHeader() {

View File

@@ -71,7 +71,7 @@ public final class PopupImplUtil {
return null; return null;
} }
/** @deprecated Use @{@link PopupUtil#setPopupToggleComponent}, but in the most cases it is not needed any more */ /** @deprecated Use {@link PopupUtil#setPopupToggleComponent}, but in the most cases it is not needed any more */
@Deprecated(forRemoval = true) @Deprecated(forRemoval = true)
public static void setPopupToggleButton(@NotNull JBPopup jbPopup, @Nullable Component toggleButton) { public static void setPopupToggleButton(@NotNull JBPopup jbPopup, @Nullable Component toggleButton) {
PopupUtil.setPopupToggleComponent(jbPopup, toggleButton); PopupUtil.setPopupToggleComponent(jbPopup, toggleButton);

View File

@@ -16,7 +16,7 @@ import java.lang.annotation.*;
* <li>URL</li> * <li>URL</li>
* <li>Programming language or framework name</li> * <li>Programming language or framework name</li>
* </ul> * </ul>
* Avoid using NlsSafe just to suppress the "hardcoded string" inspection warning. Use @{@link NonNls} * Avoid using NlsSafe just to suppress the "hardcoded string" inspection warning. Use {@link NonNls @NonNls}
* if something is not intended to be displayed to the user: internal identifier, XML tag attribute, * if something is not intended to be displayed to the user: internal identifier, XML tag attribute,
* substring to be searched in the external process output, etc. * substring to be searched in the external process output, etc.
* <p> * <p>

View File

@@ -31,7 +31,7 @@ import static java.nio.file.StandardOpenOption.*;
* like 'flush' and 'isDirty', and doesn't implement {@link DurableDataEnumerator}</li> * like 'flush' and 'isDirty', and doesn't implement {@link DurableDataEnumerator}</li>
* <li>Could have >1 id for same value * <li>Could have >1 id for same value
* (i.e. it violates general {@link DataEnumerator} contract -- this is to keep backward-compatible behavior)</li> * (i.e. it violates general {@link DataEnumerator} contract -- this is to keep backward-compatible behavior)</li>
* <li>Uses CopyOnWrite for updating state, so {@link #valueOf(int)}/@{@link #enumerate(String)} are wait-free * <li>Uses CopyOnWrite for updating state, so {@link #valueOf(int)}/{@link #enumerate(String)} are wait-free
* for already existing value/id</li> * for already existing value/id</li>
* </ul> * </ul>
* <p> * <p>

View File

@@ -40,7 +40,7 @@ public class IgnoreTokenType extends IElementType {
private final String debugName; private final String debugName;
/** /**
* Builds a new instance of @{link IgnoreTokenType}. * Builds a new instance of {@link IgnoreTokenType}.
*/ */
public IgnoreTokenType(@NotNull @NonNls String debugName) { public IgnoreTokenType(@NotNull @NonNls String debugName) {
super(debugName, IgnoreLanguage.INSTANCE); super(debugName, IgnoreLanguage.INSTANCE);

View File

@@ -57,7 +57,7 @@ public class IgnoreReferenceContributor extends PsiReferenceContributor {
} }
/** /**
* Returns references for given @{link PsiElement}. * Returns references for given {@link PsiElement}.
* *
* @param psiElement current element * @param psiElement current element
* @param processingContext context * @param processingContext context

View File

@@ -35,7 +35,7 @@ import static java.awt.GridBagConstraints.CENTER;
import static java.awt.GridBagConstraints.HORIZONTAL; import static java.awt.GridBagConstraints.HORIZONTAL;
/** /**
* @deprecated Completely replaced with @{link {@link IdePluginModuleBuilder}. * @deprecated Completely replaced with {@link IdePluginModuleBuilder}.
*/ */
@Deprecated(forRemoval = true) @Deprecated(forRemoval = true)
public class PluginModuleBuilder extends JavaModuleBuilder { public class PluginModuleBuilder extends JavaModuleBuilder {

View File

@@ -22,7 +22,7 @@ public class BundleFactory {
/** /**
* Create bundle object from directory. * Create bundle object from directory.
* Return {code}null{code} if bundle type can't be defined or * Return {@code null} if bundle type can't be defined or
* if IO exception occurred while reading directory. * if IO exception occurred while reading directory.
* *
* @return Bundle object or null * @return Bundle object or null