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

snippets: ep_list_legend & cleanup

Browse Source
This commit is contained in:
Yann Cébron 2022-12-01 12:37:39 +01:00
parent d2204da8b8
commit c8e98ce1f5
17 changed files with 72 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reference_guide/api_changes_list_2022.md
View File

@ -66,7 +66,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
## 2022.3
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
### IntelliJ Platform 2022.3

2
reference_guide/api_changes_list_2023.md
View File

@ -64,7 +64,7 @@ NOTE: Entries not starting with code quotes (`name`) can be added to document no
<include from="snippets.md" element-id="apiChangesJavaVersion"/>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
## 2023.1

38
topics/_shared/snippets.md
View File

@ -51,3 +51,41 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here](
{style="note"}
</snippet>
<snippet id="ep_list_legend">
> 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<br/><br/>Extension Point: Declared with `area="IDEA_PROJECT"`<br/>Listener: registered in [`<projectListeners>`](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
</snippet>

4
topics/appendix/api_notable/api_notable_list_2022.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Notable Changes in IntelliJ Platform and Plugins API 2022.*)
# Notable Changes in IntelliJ Platform and Plugins API 2022.*
<!-- Copyright 2000-2022 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. -->
@ -6,7 +6,7 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here](
## 2022.3
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
### IntelliJ Platform 2022.3

4
topics/appendix/api_notable/api_notable_list_2023.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Notable Changes in IntelliJ Platform and Plugins API 2023.*)
# Notable Changes in IntelliJ Platform and Plugins API 2023.*
<!-- Copyright 2000-2022 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. -->
@ -6,7 +6,7 @@ _Early Access Program_ (EAP) releases of upcoming versions are available [here](
## 2023.1
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
### IntelliJ Platform 2023.1

43
topics/appendix/resources/extension_point_list.md
View File

@ -17,43 +17,7 @@
> See also [](explore_api.md) for more information and strategies.
>
<snippet id="ep_list_legend">
> 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<br/><br/>Extension Point: Declared with `area="IDEA_PROJECT"`<br/>Listener: registered in [`<projectListeners>`](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
</snippet>
<include from="snippets.md" element-id="ep_list_legend"/>
## 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

4
topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Gradle IntelliJ Plugin – FAQ)
# Gradle IntelliJ Plugin – FAQ
<!-- Copyright 2000-2022 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. -->
@ -6,7 +6,7 @@
### How to target 2022.3 platform
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
### How to modify JVM arguments of runIde task

4
topics/basics/getting_started/build_number_ranges.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Build Number Ranges)
# Build Number Ranges
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
@ -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).
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"></include>
<include from="tools_gradle_intellij_plugin.md" element-id="gradle_plugin_223_problem"/>
| Branch number | IntelliJ Platform version |
|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|

4
topics/products/appcode/appcode_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: AppCode Extension Point and Listener List)
# AppCode Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## AppCode

4
topics/products/clion/clion_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: CLion Extension Point and Listener List)
# CLion Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## CLion

4
topics/products/datagrip/data_grip_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: DataGrip Extension Point and Listener List)
# DataGrip Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## DataGrip

4
topics/products/goland/goland_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: GoLand Extension Point and Listener List)
# GoLand Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## GoLand

4
topics/products/idea/spring_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Spring API Extension Point and Listener List)
# Spring API Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -6,7 +6,7 @@
50 Extension Points and 5 Listeners for Spring API
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## Spring

4
topics/products/phpstorm/php_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: PHP Extension Point and Listener List)
# PHP Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## PhpStorm

4
topics/products/rider/rider_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: Rider Extension Point and Listener List)
# Rider Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## Rider

4
topics/products/rubymine/rubymine_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: RubyMine Extension Point and Listener List)
# RubyMine Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## RubyMine

4
topics/products/webstorm/webstorm_extension_point_list.md
View File

@ -1,4 +1,4 @@
[//]: # (title: WebStorm Extension Point and Listener List)
# WebStorm Extension Point and Listener List
<show-structure for="chapter" depth="2"/>
@ -8,7 +8,7 @@
See [](extension_point_list.md) for IntelliJ Platform.
<include from="extension_point_list.md" element-id="ep_list_legend"></include>
<include from="snippets.md" element-id="ep_list_legend"/>
## WebStorm