From 6aa203814a20cc497f6ac20c5643691e4457cf1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Wed, 14 Feb 2024 18:01:11 +0100 Subject: [PATCH] [docs] update links to IntelliJ Platform SDK Docs GitOrigin-RevId: 543b8a02e71e543f97d263a0de4df41e196ff5a0 --- .../src/com/intellij/lang/annotation/Annotator.java | 2 +- .../src/com/intellij/openapi/application/Application.java | 2 +- .../com/intellij/openapi/module/ModuleServiceManager.java | 4 ++-- .../core-api/src/com/intellij/psi/FileViewProvider.java | 4 ++-- .../src/com/intellij/ide/plugins/PluginLoadingResult.kt | 2 +- .../com/intellij/openapi/components/ComponentManager.java | 4 ++-- .../com/intellij/openapi/extensions/ExtensionPointName.kt | 6 ++++-- .../extensions/src/com/intellij/util/messages/MessageBus.kt | 6 +++--- .../src/com/intellij/openapi/wm/ToolWindowFactory.kt | 2 +- .../src/com/intellij/ide/ui/UIThemeMetadataProvider.java | 4 ++-- platform/service-container/overview.md | 2 +- .../intellij/openapi/progress/ProcessCanceledException.java | 2 +- platform/util/src/com/intellij/openapi/Disposable.java | 4 ++-- platform/util/src/com/intellij/openapi/util/Disposer.java | 4 ++-- plugins/kotlin/CONTRIBUTING.md | 2 +- 15 files changed, 26 insertions(+), 24 deletions(-) diff --git a/platform/analysis-api/src/com/intellij/lang/annotation/Annotator.java b/platform/analysis-api/src/com/intellij/lang/annotation/Annotator.java index c7f52d99f76d..3ee0ed6b500b 100644 --- a/platform/analysis-api/src/com/intellij/lang/annotation/Annotator.java +++ b/platform/analysis-api/src/com/intellij/lang/annotation/Annotator.java @@ -11,7 +11,7 @@ import org.jetbrains.annotations.NotNull; * DO NOT STORE any state inside annotator. * If you absolutely must, clear the state upon exit from the {@link #annotate(PsiElement, AnnotationHolder)} method. *

- * See Syntax Highlighting and Error Highlighting for an overview. + * See Syntax Highlighting and Error Highlighting for an overview. *

* Please note: annotators are executed in arbitrary order. *

diff --git a/platform/core-api/src/com/intellij/openapi/application/Application.java b/platform/core-api/src/com/intellij/openapi/application/Application.java index a66d27c081c7..bd00ea6e7381 100644 --- a/platform/core-api/src/com/intellij/openapi/application/Application.java +++ b/platform/core-api/src/com/intellij/openapi/application/Application.java @@ -50,7 +50,7 @@ import java.util.concurrent.Future; *

* If there are read actions running at this moment {@code runWriteAction} is blocked until they are completed. *

- * See also General Threading Rules. + * See also General Threading Rules. */ public interface Application extends ComponentManager { diff --git a/platform/core-api/src/com/intellij/openapi/module/ModuleServiceManager.java b/platform/core-api/src/com/intellij/openapi/module/ModuleServiceManager.java index f2a962103815..73a179f03c6f 100644 --- a/platform/core-api/src/com/intellij/openapi/module/ModuleServiceManager.java +++ b/platform/core-api/src/com/intellij/openapi/module/ModuleServiceManager.java @@ -1,11 +1,11 @@ -// Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.openapi.module; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * @deprecated do not use module services, use other kinds of services + * @deprecated do not use module services, use other kinds of services * instead */ @Deprecated diff --git a/platform/core-api/src/com/intellij/psi/FileViewProvider.java b/platform/core-api/src/com/intellij/psi/FileViewProvider.java index 75ddd0a1e5d6..916bf6da1d0d 100644 --- a/platform/core-api/src/com/intellij/psi/FileViewProvider.java +++ b/platform/core-api/src/com/intellij/psi/FileViewProvider.java @@ -1,4 +1,4 @@ -// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.psi; import com.intellij.lang.Language; @@ -18,7 +18,7 @@ import java.util.Set; *

* Custom providers are registered via {@link FileViewProviderFactory}. *

- * Please see File View Providers + * Please see File View Providers * for high-level overview. * * @see PsiFile#getViewProvider() diff --git a/platform/core-impl/src/com/intellij/ide/plugins/PluginLoadingResult.kt b/platform/core-impl/src/com/intellij/ide/plugins/PluginLoadingResult.kt index 9aa6b543fcff..26c69eeabc65 100644 --- a/platform/core-impl/src/com/intellij/ide/plugins/PluginLoadingResult.kt +++ b/platform/core-impl/src/com/intellij/ide/plugins/PluginLoadingResult.kt @@ -11,7 +11,7 @@ import org.jetbrains.annotations.ApiStatus import org.jetbrains.annotations.TestOnly import org.jetbrains.annotations.VisibleForTesting -// https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html +// https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html // If a plugin does not include any module dependency tags in its plugin.xml, // it's assumed to be a legacy plugin and is loaded only in IntelliJ IDEA. @ApiStatus.Internal diff --git a/platform/extensions/src/com/intellij/openapi/components/ComponentManager.java b/platform/extensions/src/com/intellij/openapi/components/ComponentManager.java index e5e1551f206d..2a3ab8d11364 100644 --- a/platform/extensions/src/com/intellij/openapi/components/ComponentManager.java +++ b/platform/extensions/src/com/intellij/openapi/components/ComponentManager.java @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.openapi.components; import com.intellij.diagnostic.ActivityCategory; @@ -66,7 +66,7 @@ public interface ComponentManager extends UserDataHolder, Disposable, AreaInstan * or is about to be disposed (e.g. the {@link com.intellij.openapi.project.impl.ProjectExImpl#dispose()} was called but not completed yet) *
* The result is only valid inside read action because the application/project/module can be disposed at any moment. - * (see more details on read actions) + * (see more details on read actions) */ boolean isDisposed(); diff --git a/platform/extensions/src/com/intellij/openapi/extensions/ExtensionPointName.kt b/platform/extensions/src/com/intellij/openapi/extensions/ExtensionPointName.kt index 9dda0c3ded70..ee9e0e22a752 100644 --- a/platform/extensions/src/com/intellij/openapi/extensions/ExtensionPointName.kt +++ b/platform/extensions/src/com/intellij/openapi/extensions/ExtensionPointName.kt @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. @file:Suppress("DeprecatedCallableAddReplaceWith", "ReplaceGetOrSet") package com.intellij.openapi.extensions @@ -30,7 +30,9 @@ import java.util.stream.Stream import kotlin.streams.asStream /** - * Provides access to an [extension point](https://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_extension_points.html). Instances of this class can be safely stored in static final fields. + * Provides access to an [extension point](https://plugins.jetbrains.com/docs/intellij/plugin-extension-points.html). + * + * Instances of this class can be safely stored in static final fields. * * For project-level and module-level extension points use [ProjectExtensionPointName] instead to make it evident that corresponding * [AreaInstance] must be passed. diff --git a/platform/extensions/src/com/intellij/util/messages/MessageBus.kt b/platform/extensions/src/com/intellij/util/messages/MessageBus.kt index 21050fd3a3f3..3b7f1fe6c819 100644 --- a/platform/extensions/src/com/intellij/util/messages/MessageBus.kt +++ b/platform/extensions/src/com/intellij/util/messages/MessageBus.kt @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.util.messages import com.intellij.openapi.Disposable @@ -12,8 +12,8 @@ import org.jetbrains.annotations.ApiStatus.Internal * * Use [com.intellij.openapi.components.ComponentManager.getMessageBus] to obtain one. * - * Please see [Messaging Infrastructure](https://www.jetbrains.org/intellij/sdk/docs/reference_guide/messaging_infrastructure.html) and - * [Plugin Listeners](http://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_listeners.html). + * Please see [Messaging Infrastructure](https://plugins.jetbrains.com/docs/intellij/messaging-infrastructure.html) and + * [Listeners](https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html). */ interface MessageBus : Disposable { /** diff --git a/platform/platform-api/src/com/intellij/openapi/wm/ToolWindowFactory.kt b/platform/platform-api/src/com/intellij/openapi/wm/ToolWindowFactory.kt index 4c5f610f7b55..451102caa7bb 100644 --- a/platform/platform-api/src/com/intellij/openapi/wm/ToolWindowFactory.kt +++ b/platform/platform-api/src/com/intellij/openapi/wm/ToolWindowFactory.kt @@ -13,7 +13,7 @@ import javax.swing.Icon * * For localizing the tool window stripe title, add key `toolwindow.stripe.yourToolWindowId.replace(" ", "_")` to plugin's resource bundle. * - * See [Tool Windows](https://www.jetbrains.org/intellij/sdk/docs/user_interface_components/tool_windows.html) in SDK Docs. + * See [Tool Windows](https://plugins.jetbrains.com/docs/intellij/tool-windows.html) in SDK Docs. */ interface ToolWindowFactory : PossiblyDumbAware { suspend fun isApplicableAsync(project: Project): Boolean { diff --git a/platform/platform-impl/src/com/intellij/ide/ui/UIThemeMetadataProvider.java b/platform/platform-impl/src/com/intellij/ide/ui/UIThemeMetadataProvider.java index 9d543c2455ff..8f600cd7bcfb 100644 --- a/platform/platform-impl/src/com/intellij/ide/ui/UIThemeMetadataProvider.java +++ b/platform/platform-impl/src/com/intellij/ide/ui/UIThemeMetadataProvider.java @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.ide.ui; import com.intellij.openapi.diagnostic.Logger; @@ -14,7 +14,7 @@ import java.io.IOException; /** * Provides additional metadata for UI theme customization. - * See Exposing Theme Metadata. + * See Exposing Theme Metadata. */ public final class UIThemeMetadataProvider implements PluginAware { private PluginDescriptor pluginDescriptor; diff --git a/platform/service-container/overview.md b/platform/service-container/overview.md index 36d53496f90c..44994b207bb7 100644 --- a/platform/service-container/overview.md +++ b/platform/service-container/overview.md @@ -1,4 +1,4 @@ -This document is a more like a draft, that will be finally moved to [IntelliJ Platform SDK](https://www.jetbrains.org/intellij/sdk/docs/welcome.html) +This document is a more like a draft, that will be finally moved to [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij) ## Service diff --git a/platform/util/base/src/com/intellij/openapi/progress/ProcessCanceledException.java b/platform/util/base/src/com/intellij/openapi/progress/ProcessCanceledException.java index e96e8f4c0526..070760806cfb 100644 --- a/platform/util/base/src/com/intellij/openapi/progress/ProcessCanceledException.java +++ b/platform/util/base/src/com/intellij/openapi/progress/ProcessCanceledException.java @@ -18,7 +18,7 @@ import org.jetbrains.annotations.Nullable; *

* * @see com.intellij.openapi.progress.ProgressIndicator#checkCanceled() - * @see General Threading Rules + * @see General Threading Rules */ public class ProcessCanceledException extends RuntimeException implements ControlFlowException { public ProcessCanceledException() { } diff --git a/platform/util/src/com/intellij/openapi/Disposable.java b/platform/util/src/com/intellij/openapi/Disposable.java index 973c40c175c9..cab821418641 100644 --- a/platform/util/src/com/intellij/openapi/Disposable.java +++ b/platform/util/src/com/intellij/openapi/Disposable.java @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.openapi; import com.intellij.openapi.util.Disposer; @@ -24,7 +24,7 @@ import com.intellij.openapi.util.Disposer; * that need to be cleaned up before your object. *

* @see com.intellij.openapi.util.CheckedDisposable - * See Disposer and Disposable in SDK Docs. + * @see Disposer and Disposable in SDK Docs. * @see Disposer */ @SuppressWarnings("InterfaceMayBeAnnotatedFunctional") // do not use lambda as a Disposable implementation, because each Disposable instance needs identity to be stored in Disposer hierarchy correctly diff --git a/platform/util/src/com/intellij/openapi/util/Disposer.java b/platform/util/src/com/intellij/openapi/util/Disposer.java index 755aeb74f33c..a312256deffa 100644 --- a/platform/util/src/com/intellij/openapi/util/Disposer.java +++ b/platform/util/src/com/intellij/openapi/util/Disposer.java @@ -1,4 +1,4 @@ -// Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. +// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.intellij.openapi.util; import com.intellij.openapi.Disposable; @@ -13,7 +13,7 @@ import java.util.function.Predicate; *

A root node can be created via {@link #newDisposable()}, to which children are attached via subsequent calls to {@link #register(Disposable, Disposable)}. * Invoking {@link #dispose(Disposable)} will process all its registered children's {@link Disposable#dispose()} method.

*

- * See Disposer and Disposable in SDK Docs. + * @see Disposer and Disposable in SDK Docs. * @see Disposable */ public final class Disposer { diff --git a/plugins/kotlin/CONTRIBUTING.md b/plugins/kotlin/CONTRIBUTING.md index c870308aa0d0..591b0d7fabc2 100644 --- a/plugins/kotlin/CONTRIBUTING.md +++ b/plugins/kotlin/CONTRIBUTING.md @@ -70,7 +70,7 @@ You can find necessary information about how to write inspections, intentions an in the [Code Inspections](https://jetbrains.org/intellij/sdk/docs/tutorials/code_inspections.html) tutorial. It's essential to know -about [PSI](https://www.jetbrains.org/intellij/sdk/docs/basics/architectural_overview/psi.html), the source code model used in IntelliJ IDEA. +about [PSI](https://plugins.jetbrains.com/docs/intellij/psi.html), the source code model used in IntelliJ IDEA. To inspect PSI, you can use either the built-in [Psi Viewer](https://www.jetbrains.com/help/idea/psi-viewer.html) available in the "internal" mode, or an external plugin called [PsiViewer](https://plugins.jetbrains.com/plugin/227-psiviewer). For debugging purposes consider using `PsiTreeUtilsKt.printTree` function.