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: 2024.* pages

Browse Source
This commit is contained in:
Yann Cébron 2023-10-24 10:58:38 +02:00
parent a8068935e9
commit 3dae7e5551
5 changed files with 91 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ijs.tree
View File

@ -378,6 +378,7 @@
<toc-element topic="verifying_plugin_compatibility.md"/>
<toc-element topic="api_changes_list.md" toc-title="Incompatible API Changes"
accepts-web-file-names="api-changes-list-2016.html,api-changes-list-2017.html,api-changes-list-2018.html">
<toc-element topic="api_changes_list_2024.md" toc-title="2024.*"/>
<toc-element topic="api_changes_list_2023.md" toc-title="2023.*"/>
<toc-element topic="api_changes_list_2022.md" toc-title="2022.*"/>
<toc-element topic="api_changes_list_2021.md" toc-title="2021.*"/>
@ -386,6 +387,7 @@
</toc-element>
<toc-element topic="api_notable.md" toc-title="Notable API Changes"
accepts-web-file-names="api-notable-list-2018.html">
<toc-element topic="api_notable_list_2024.md" toc-title="2024.*"/>
<toc-element topic="api_notable_list_2023.md" toc-title="2023.*"/>
<toc-element topic="api_notable_list_2022.md" toc-title="2022.*"/>
<toc-element topic="api_notable_list_2021.md" toc-title="2021.*"/>

1
reference_guide/api_changes_list.md
View File

@ -76,6 +76,7 @@ Please see [](verifying_plugin_compatibility.md) on how to use Plugin Verifier a
The following pages list the breaking changes in IDE and plugin releases with required/recommended steps to take by plugin authors.
* [Changes in 2024.*](api_changes_list_2024.md)
* [Changes in 2023.*](api_changes_list_2023.md)
* [Changes in 2022.*](api_changes_list_2022.md)
* [Changes in 2021.*](api_changes_list_2021.md)

73
reference_guide/api_changes_list_2024.md Normal file
View File

@ -0,0 +1,73 @@
<!-- 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 2024.*
<!--
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.
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.
The following problem patterns are supported:
<package name> package removed
<class name> class removed
<class name> class renamed to <new class name>
<class name> class moved to package <package name>
<class name>.<method name>(<human-readable parameters>) marked abstract
<class name>.<method name>(<human-readable parameters>) abstract method added
<class name>.<method name>(<human-readable parameters>) method removed
<class name>.<method name>(<human-readable parameters>) method moved to the superclass
<class name>.<method name>(<human-readable parameters>) method return type changed from <before> to <after>
<class name>.<method name>(<human-readable parameters>) method visibility changed from <before> to <after>
<class name>.<method name>(<human-readable parameters>) method marked final
<class name>.<method name>(<human-readable parameters>) method parameter <type> removed
<class name>.<method name>(<human-readable parameters>) method parameter type changed from <before> to <after>
<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 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 parameter <type> removed
<class name>(<human-readable parameters>) constructor parameter type changed from <before> to <after>
<class name>(<human-readable parameters>) constructor visibility changed from <before> to <after>
<class name>.<field name> field removed
<class name>.<field name> field moved to the superclass
<class name>.<field name> field type changed from <before> to <after>
<class name>.<field name> field visibility changed from <before> to <after>
<property name> property removed from resource bundle <bundle name>
Where the placeholders must be enclosed in code quotes (`name`):
<class name> is a fully-qualified name of the class, e.g. `com.intellij.openapi.actionSystem.AnAction$InnerClass`.
<method name> is the exact method's name. Note that constructors have dedicated patterns.
<human-readable parameters> is a string representing parameters, which are not necessarily fully qualified. They do not affect the parser. For example, instead of (java.lang.Object, java.util.List, int) you are free to write (Object, List<String>, int)
<parameter name> is exact name of the method's parameter
<property name> is a full name of a property from .properties file, like `some.action.description`
<bundle name> is a fully qualified name of the property bundle, which includes its package, like `message.IdeBundle`
NOTE: If a code change you're trying to document doesn't match any of the above patterns, fill in a ticket in the YouTrack.
An example of a ticket is https://youtrack.jetbrains.com/issue/MP-1218. Until supported, you may document the change as you prefer, and I will correct it later.
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.
-->
<link-summary>List of known Breaking API Changes in 2024.*</link-summary>
<include from="snippets.md" element-id="apiChangesHeader"/>
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
## 2024.1
### IntelliJ Platform 2024.1

1
topics/appendix/api_notable/api_notable.md
View File

@ -10,6 +10,7 @@ Plugin authors are encouraged to verify their compatible releases take advantage
<include from="snippets.md" element-id="subscribeNews"/>
* [Changes in 2024.*](api_notable_list_2024.md)
* [Changes in 2023.*](api_notable_list_2023.md)
* [Changes in 2022.*](api_notable_list_2022.md)
* [Changes in 2021.*](api_notable_list_2021.md)

14
topics/appendix/api_notable/api_notable_list_2024.md Normal file
View File

@ -0,0 +1,14 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Notable Changes in IntelliJ Platform and Plugins API 2024.*
<link-summary>List of known Notable API Changes in 2024.*</link-summary>
_Early Access Program_ (EAP) releases of upcoming versions are available [here](https://eap.jetbrains.com).
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
## 2024.1
### IntelliJ Platform 2024.1