diff --git a/reference_guide/api_changes_list_2022.md b/reference_guide/api_changes_list_2022.md index 793c192b7..c1da9daef 100644 --- a/reference_guide/api_changes_list_2022.md +++ b/reference_guide/api_changes_list_2022.md @@ -66,7 +66,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no ## 2022.3 - + ### IntelliJ Platform 2022.3 diff --git a/reference_guide/api_changes_list_2023.md b/reference_guide/api_changes_list_2023.md index 18ca788a4..e992fe26d 100644 --- a/reference_guide/api_changes_list_2023.md +++ b/reference_guide/api_changes_list_2023.md @@ -64,7 +64,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no - + ## 2023.1 diff --git a/topics/_shared/snippets.md b/topics/_shared/snippets.md index a6132d668..9f91426bd 100644 --- a/topics/_shared/snippets.md +++ b/topics/_shared/snippets.md @@ -51,3 +51,41 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here]( {style="note"} + + + +> See [](plugin_extensions.md) on how to declare extensions in your plugin. +> +> See [](plugin_listeners.md) on how to register listeners. +> + +## Legend + +### Listeners + +**Topic** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). + +**Listener** links corresponding listener to implement. + +### Extension Points + +**Extension Point** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). + +**Implementation** is related Extension Point class. + +### Tags + +| Icon | Description | Details | +|-----------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ![Deprecated][deprecated] | Deprecated API | Please see code documentation for replacement | +| ![Experimental API][experimental] | Experimental API | Annotated with [`@ApiStatus.Experimental`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), API might be altered or removed without prior notice | +| ![Internal API][internal] | Internal API | Annotated with [`@ApiStatus.Internal`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), should not be used by 3rd party, see [](api_internal.md) | +| ![Project-Level][project-level] | Project-Level Extension Point/Topic | Can have [`Project`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/Project.java) as constructor parameter

Extension Point: Declared with `area="IDEA_PROJECT"`
Listener: registered in [``](plugin_configuration_file.md#idea-plugin__projectListeners) | +| ![Non-Dynamic][non-dynamic] | Non-Dynamic Extension Point | Installation/update of plugin requires IDE restart ([Dynamic Plugins](dynamic_plugins.md)) | + +[experimental]: https://img.shields.io/badge/-Experimental_API-red?style=flat-square +[internal]: https://img.shields.io/badge/-Internal_API-darkred?style=flat-square +[project-level]: https://img.shields.io/badge/-Project--Level-blue?style=flat-square +[non-dynamic]: https://img.shields.io/badge/-Non--Dynamic-orange?style=flat-square +[deprecated]: https://img.shields.io/badge/-Deprecated-lightgrey?style=flat-square + diff --git a/topics/appendix/api_notable/api_notable_list_2022.md b/topics/appendix/api_notable/api_notable_list_2022.md index 03593004a..10430fb3b 100644 --- a/topics/appendix/api_notable/api_notable_list_2022.md +++ b/topics/appendix/api_notable/api_notable_list_2022.md @@ -1,4 +1,4 @@ -[//]: # (title: Notable Changes in IntelliJ Platform and Plugins API 2022.*) +# Notable Changes in IntelliJ Platform and Plugins API 2022.* @@ -6,7 +6,7 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here]( ## 2022.3 - + ### IntelliJ Platform 2022.3 diff --git a/topics/appendix/api_notable/api_notable_list_2023.md b/topics/appendix/api_notable/api_notable_list_2023.md index 7ad7544ef..ea5b3eb6d 100644 --- a/topics/appendix/api_notable/api_notable_list_2023.md +++ b/topics/appendix/api_notable/api_notable_list_2023.md @@ -1,4 +1,4 @@ -[//]: # (title: Notable Changes in IntelliJ Platform and Plugins API 2023.*) +# Notable Changes in IntelliJ Platform and Plugins API 2023.* @@ -6,7 +6,7 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here]( ## 2023.1 - + ### IntelliJ Platform 2023.1 diff --git a/topics/appendix/resources/extension_point_list.md b/topics/appendix/resources/extension_point_list.md index 20e98363b..3eaaa15a4 100644 --- a/topics/appendix/resources/extension_point_list.md +++ b/topics/appendix/resources/extension_point_list.md @@ -17,43 +17,7 @@ > See also [](explore_api.md) for more information and strategies. > - - -> See [](plugin_extensions.md) on how to declare extensions in your plugin. -> -> See [](plugin_listeners.md) on how to register listeners. -> - -## Legend - -### Listeners - -**Topic** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). - -**Listener** links corresponding listener to implement. - -### Extension Points - -**Extension Point** searches for usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). - -**Implementation** is related Extension Point class. - -### Tags - -| Icon | Description | Details | -|-----------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| ![Deprecated][deprecated] | Deprecated API | Please see code documentation for replacement | -| ![Experimental API][experimental] | Experimental API | Annotated with [`@ApiStatus.Experimental`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), API might be altered or removed without prior notice | -| ![Internal API][internal] | Internal API | Annotated with [`@ApiStatus.Internal`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), should not be used by 3rd party, see [](api_internal.md) | -| ![Project-Level][project-level] | Project-Level Extension Point/Topic | Can have [`Project`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/Project.java) as constructor parameter

Extension Point: Declared with `area="IDEA_PROJECT"`
Listener: registered in [``](plugin_configuration_file.md#idea-plugin__projectListeners) | -| ![Non-Dynamic][non-dynamic] | Non-Dynamic Extension Point | Installation/update of plugin requires IDE restart ([Dynamic Plugins](dynamic_plugins.md)) | - -[experimental]: https://img.shields.io/badge/-Experimental_API-red?style=flat-square -[internal]: https://img.shields.io/badge/-Internal_API-darkred?style=flat-square -[project-level]: https://img.shields.io/badge/-Project--Level-blue?style=flat-square -[non-dynamic]: https://img.shields.io/badge/-Non--Dynamic-orange?style=flat-square -[deprecated]: https://img.shields.io/badge/-Deprecated-lightgrey?style=flat-square - + ## IntelliJ Platform @@ -2792,3 +2756,8 @@ | [com.android.resourceImporter](https://jb.gg/ipe?extensions=com.android.resourceImporter) ![Non-Dynamic][non-dynamic] | [`ResourceImporter`](%gh-ij-android%android/src/com/android/tools/idea/ui/resourcemanager/plugin/ResourceImporter.kt) | | [com.android.resourceViewer](https://jb.gg/ipe?extensions=com.android.resourceViewer) ![Non-Dynamic][non-dynamic] | [`DesignAssetRenderer`](%gh-ij-android%android/src/com/android/tools/idea/ui/resourcemanager/plugin/DesignAssetRenderer.kt) | +[experimental]: https://img.shields.io/badge/-Experimental_API-red?style=flat-square +[internal]: https://img.shields.io/badge/-Internal_API-darkred?style=flat-square +[project-level]: https://img.shields.io/badge/-Project--Level-blue?style=flat-square +[non-dynamic]: https://img.shields.io/badge/-Non--Dynamic-orange?style=flat-square +[deprecated]: https://img.shields.io/badge/-Deprecated-lightgrey?style=flat-square diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md index 18d760eec..fadd9b862 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md @@ -1,4 +1,4 @@ -[//]: # (title: Gradle IntelliJ Plugin – FAQ) +# Gradle IntelliJ Plugin – FAQ @@ -6,7 +6,7 @@ ### How to target 2022.3 platform - + ### How to modify JVM arguments of runIde task diff --git a/topics/basics/getting_started/build_number_ranges.md b/topics/basics/getting_started/build_number_ranges.md index 6fa01a82d..3cc37aa58 100644 --- a/topics/basics/getting_started/build_number_ranges.md +++ b/topics/basics/getting_started/build_number_ranges.md @@ -1,4 +1,4 @@ -[//]: # (title: Build Number Ranges) +# Build Number Ranges @@ -63,7 +63,7 @@ Usually you should omit the product ID and use only the branch number and build Please see also corresponding entries in [Incompatible API Changes](api_changes_list.md) and [Notable API Changes](api_notable.md). - + | Branch number | IntelliJ Platform version | |-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/topics/products/appcode/appcode_extension_point_list.md b/topics/products/appcode/appcode_extension_point_list.md index 49e8a7c22..31a4c1c91 100644 --- a/topics/products/appcode/appcode_extension_point_list.md +++ b/topics/products/appcode/appcode_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: AppCode Extension Point and Listener List) +# AppCode Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## AppCode diff --git a/topics/products/clion/clion_extension_point_list.md b/topics/products/clion/clion_extension_point_list.md index 108a3031c..c96f191c0 100644 --- a/topics/products/clion/clion_extension_point_list.md +++ b/topics/products/clion/clion_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: CLion Extension Point and Listener List) +# CLion Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## CLion diff --git a/topics/products/datagrip/data_grip_extension_point_list.md b/topics/products/datagrip/data_grip_extension_point_list.md index 076e262ec..a2378cabd 100644 --- a/topics/products/datagrip/data_grip_extension_point_list.md +++ b/topics/products/datagrip/data_grip_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: DataGrip Extension Point and Listener List) +# DataGrip Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## DataGrip diff --git a/topics/products/goland/goland_extension_point_list.md b/topics/products/goland/goland_extension_point_list.md index f18d116a1..aa3d6213d 100644 --- a/topics/products/goland/goland_extension_point_list.md +++ b/topics/products/goland/goland_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: GoLand Extension Point and Listener List) +# GoLand Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## GoLand diff --git a/topics/products/idea/spring_extension_point_list.md b/topics/products/idea/spring_extension_point_list.md index 4a7f852f7..dbe0d5d19 100644 --- a/topics/products/idea/spring_extension_point_list.md +++ b/topics/products/idea/spring_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: Spring API Extension Point and Listener List) +# Spring API Extension Point and Listener List @@ -6,7 +6,7 @@ 50 Extension Points and 5 Listeners for Spring API - + ## Spring diff --git a/topics/products/phpstorm/php_extension_point_list.md b/topics/products/phpstorm/php_extension_point_list.md index 99727b4c3..dd9ef940b 100644 --- a/topics/products/phpstorm/php_extension_point_list.md +++ b/topics/products/phpstorm/php_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: PHP Extension Point and Listener List) +# PHP Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## PhpStorm diff --git a/topics/products/rider/rider_extension_point_list.md b/topics/products/rider/rider_extension_point_list.md index 26a6a395b..84b576361 100644 --- a/topics/products/rider/rider_extension_point_list.md +++ b/topics/products/rider/rider_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: Rider Extension Point and Listener List) +# Rider Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## Rider diff --git a/topics/products/rubymine/rubymine_extension_point_list.md b/topics/products/rubymine/rubymine_extension_point_list.md index efb4a84ec..37a5e4002 100644 --- a/topics/products/rubymine/rubymine_extension_point_list.md +++ b/topics/products/rubymine/rubymine_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: RubyMine Extension Point and Listener List) +# RubyMine Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## RubyMine diff --git a/topics/products/webstorm/webstorm_extension_point_list.md b/topics/products/webstorm/webstorm_extension_point_list.md index 7c612a2b7..65918e520 100644 --- a/topics/products/webstorm/webstorm_extension_point_list.md +++ b/topics/products/webstorm/webstorm_extension_point_list.md @@ -1,4 +1,4 @@ -[//]: # (title: WebStorm Extension Point and Listener List) +# WebStorm Extension Point and Listener List @@ -8,7 +8,7 @@ See [](extension_point_list.md) for IntelliJ Platform. - + ## WebStorm