intellij-community
intellij-community copied to clipboard
Fix Javadoc syntax for `{@code}` and `{@link}`
Incorrect usages of Javadoc syntax {@code} and {@link} in various Java classes have been fixed. Details – in the commit message.
Rebased onto fresh master to resolve merge conflict in ApplicationActivationListener.java. Found one new Javadoc syntax issue to fix in SimpleStringPersistentEnumerator.java. Range diff of the force push:
1: 90da83cd1298 ! 1: 3b15ca677e4f fix Javadoc syntax for {@code} and {@link}
@@ platform/analysis-impl/src/com/intellij/codeInsight/quickfix/UnresolvedReference
void startComputingNextQuickFixes(@NotNull PsiFile file, @NotNull Editor editor, @NotNull ProperTextRange visibleRange);
}
- ## platform/ide-core/src/com/intellij/openapi/application/ApplicationActivationListener.java ##
-@@ platform/ide-core/src/com/intellij/openapi/application/ApplicationActivationListener.java: public interface ApplicationActivationListener {
- default void applicationDeactivated(@NotNull IdeFrame ideFrame) { }
-
- /**
-- * This is more precise notification than {code applicationDeactivated} callback.
-+ * This is more precise notification than {@link #applicationDeactivated} callback.
- * It is intended for the focus subsystem and purposes where we do not want to be bothered by false application deactivation events.
- * <p>
- * The shortcoming of the method is that a notification is delivered with a delay.
-- * See the {code app.deactivation.timeout} key in the registry.
-+ * See the {@code app.deactivation.timeout} key in the registry.
- */
- default void delayedApplicationDeactivated(@NotNull Window ideFrame) { }
- }
-
## platform/lang-impl/src/com/intellij/ide/actions/BigPopupUI.java ##
@@ platform/lang-impl/src/com/intellij/ide/actions/BigPopupUI.java: public abstract class BigPopupUI extends BorderLayoutPanel implements Disposable
protected abstract ListCellRenderer<Object> createCellRenderer();
@@ platform/util/base/src/com/intellij/openapi/util/NlsSafe.java: import java.lang.
* substring to be searched in the external process output, etc.
* <p>
+ ## platform/util/src/com/intellij/util/io/SimpleStringPersistentEnumerator.java ##
+@@ platform/util/src/com/intellij/util/io/SimpleStringPersistentEnumerator.java: import static java.nio.charset.StandardCharsets.UTF_8;
+ * <li>Always has synchronized state between disk and memory state</li>
+ * <li>Could have >1 id for same value
+ * (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>
+ * </ul>
+ */
+
## platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/psi/IgnoreTokenType.java ##
@@ platform/vcs-impl/src/com/intellij/openapi/vcs/changes/ignore/psi/IgnoreTokenType.java: public class IgnoreTokenType extends IElementType {
private final String debugName;
Will push to internal repo, thank you.
26d8b55820e67d97952834db5dac778554cf855e