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: clarify instructions

Browse Source
This commit is contained in:
Yann Cébron 2024-03-13 10:47:02 +01:00
parent 954795a60e
commit cf25990719
6 changed files with 40 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
reference_guide/api_changes_list_2019.md
View File

@ -1,15 +1,17 @@
# Incompatible Changes in IntelliJ Platform and Plugins API 2019.*
<!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
# Incompatible Changes in IntelliJ Platform and Plugins API 2019.*
<!-- <!--
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
@ -29,6 +31,7 @@ The following problem patterns are supported:
<class name>.<method name> method <parameter name> parameter marked @<class name> <class name>.<method name> method <parameter name> parameter marked @<class name>
<class name> (class|interface) now (extends|implements) <class name> and inherits its final method <method name>(<human-readable parameters>)? <class name> (class|interface) now (extends|implements) <class name> and inherits its final method <method name>(<human-readable parameters>)?
<class name> (class|interface) now (extends|implements) <class name> and inherits its abstract method <method name>(<human-readable parameters>)? <class name> (class|interface) now (extends|implements) <class name> and inherits its abstract method <method name>(<human-readable parameters>)?
<class name> class now interface
<class name>(<human-readable parameters>) constructor removed <class name>(<human-readable parameters>) constructor removed
<class name>(<human-readable parameters>) constructor parameter <type> removed <class name>(<human-readable parameters>) constructor parameter <type> removed
@ -56,7 +59,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 in 2019.*</link-summary> <link-summary>List of known Breaking API Changes in 2019.*</link-summary>

16
reference_guide/api_changes_list_2020.md
View File

@ -1,15 +1,17 @@
<!-- Copyright 2000-2024 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
# Incompatible Changes in IntelliJ Platform and Plugins API 2020.* # Incompatible Changes in IntelliJ Platform and Plugins API 2020.*
<!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE 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
@ -57,7 +59,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 in 2020.*</link-summary> <link-summary>List of known Breaking API Changes in 2020.*</link-summary>

14
reference_guide/api_changes_list_2021.md
View File

@ -1,15 +1,17 @@
# Incompatible Changes in IntelliJ Platform and Plugins API 2021.* <!-- Copyright 2000-2024 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> # Incompatible Changes in IntelliJ Platform and Plugins API 2021.*
<!-- <!--
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 @Deprecated(forRemoval=true), @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
@ -57,7 +59,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 in 2021.*</link-summary> <link-summary>List of known Breaking API Changes in 2021.*</link-summary>

10
reference_guide/api_changes_list_2022.md
View File

@ -1,15 +1,17 @@
# Incompatible Changes in IntelliJ Platform and Plugins API 2022.* <!-- Copyright 2000-2024 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> # Incompatible Changes in IntelliJ Platform and Plugins API 2022.*
<!-- <!--
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 @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, 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

4
reference_guide/api_changes_list_2023.md
View File

@ -7,7 +7,9 @@ Before documenting a breaking API change, please make sure that the change canno
APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, 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 and must be followed EXACTLY: The following problem patterns are supported and must be followed EXACTLY:

6
reference_guide/api_changes_list_2024.md
View File

@ -7,7 +7,9 @@ Before documenting a breaking API change, please make sure that the change canno
APIs marked with @Deprecated(forRemoval=true), @ApiStatus.Experimental, @ApiStatus.Internal/IntellijInternalApi, 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 and must be followed EXACTLY: The following problem patterns are supported and must be followed EXACTLY:
@ -73,7 +75,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
### IntelliJ Platform 2024.2 ### IntelliJ Platform 2024.2
`org.apache.sanselan.util` package removed `org.apache.sanselan.util` package removed
: `org.apache.sanselan.util.IOUtils` compatibility shim is obsolete; instead, please use JRE methods or `org.apache.commons.io.IOUtils` : `org.apache.sanselan.util.IOUtils` compatibility shim is obsolete; instead, please use JRE methods or `org.apache.commons.io.IOUtils`.
## 2024.1 ## 2024.1