hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

api_changes_list.md: sync instructions

Browse Source
This commit is contained in:
Yann Cébron 2024-03-13 14:31:49 +01:00
parent a2a2ac9026
commit 77f0523bc7
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
reference_guide/api_changes_list.md
View File

@ -1,17 +1,19 @@
<!-- 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. -->
# Incompatible Changes in IntelliJ Platform and Plugins API # Incompatible Changes in IntelliJ Platform and Plugins API
<!-- <!--
=============== DO NOT RENAME OR MOVE THIS FILE =============== =============== DO NOT RENAME OR MOVE THIS FILE ===============
Before documenting a breaking API change, please, make sure that the change cannot be avoided in an alternative way. Before documenting a breaking API change, please make sure that the change cannot be avoided in an alternative way.
APIs marked with @ApiStatus.Experimental, @ApiStatus.Internal, or @ApiStatus.ScheduledForRemoval don't need to be documented. APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, or @ApiStatus.ScheduledForRemoval don't need to be documented.
To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description and recommended fix/action. To document a new incompatible change, add a new line with the problem pattern followed by a 2nd line with ": "-prefixed human-readable description
and recommended fix/action (please write full sentence ending with '.', see existing entries as reference).
Non-platform changes must be grouped under relevant section for plugin.
The following problem patterns are supported: The following problem patterns are supported and must be followed EXACTLY:
<package name> package removed <package name> package removed
@ -59,7 +61,7 @@ An example of a ticket is https://youtrack.jetbrains.com/issue/MP-1218. Until su
NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](https://github.com/JetBrains/intellij-community/tree/master/) NOTE: You are allowed to prettify the pattern using links: [`org.example.Foo`](https://github.com/JetBrains/intellij-community/tree/master/)
NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification. NOTE: Entries not starting with code quotes (`name`) can be added to document non-code changes and will be skipped in API verification.
--> -->
<link-summary>List of known Breaking API Changes by version</link-summary> <link-summary>List of known Breaking API Changes by version</link-summary>