From 11c4851dcffaaaec6325d4d4b61ac3fa77077586 Mon Sep 17 00:00:00 2001 From: Karol Lewandowski Date: Thu, 16 Jan 2025 11:27:06 +0100 Subject: [PATCH] Add information about descriptor files documentation provider --- topics/_shared/snippets.md | 10 ++++++++++ .../plugin_configuration_file.md | 18 ++++++++++-------- .../live_templates_configuration_file.md | 2 ++ 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/topics/_shared/snippets.md b/topics/_shared/snippets.md index 4a6debc8f..d70ee2b28 100644 --- a/topics/_shared/snippets.md +++ b/topics/_shared/snippets.md @@ -140,3 +140,13 @@ See [](verifying_plugin_compatibility.md) for overview of API status. [dumb-aware]: https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square + + + +> Elements described on this page are available in [quick documentation](https://www.jetbrains.com/help/idea/viewing-reference-information.html#inline-quick-documentation) since IntelliJ IDEA 2025.1. +> +> The [Plugin DevKit](https://plugins.jetbrains.com/plugin/22851-plugin-devkit) plugin must be installed and enabled. +> +{style="note"} + + diff --git a/topics/basics/plugin_structure/plugin_configuration_file.md b/topics/basics/plugin_structure/plugin_configuration_file.md index 3e57c3fe8..99f066573 100644 --- a/topics/basics/plugin_structure/plugin_configuration_file.md +++ b/topics/basics/plugin_structure/plugin_configuration_file.md @@ -35,6 +35,8 @@ See also [](marketing.md) about widgets and badges. Deprecated elements are omitted in the list below. + + [//]: # (GENERATED CONTENT START) [//]: # (This content is generated by generate_descriptor_pages.main.kts script.) @@ -586,7 +588,7 @@ Attributes `order`.
To not clash with other plugins defining extensions with the same identifier, - consider prepending the identifier with a prefix related to the plugin [``](#idea-plugin__id) or + consider prepending the identifier with a prefix related to the plugin [``](#idea-plugin__id) or [``](#idea-plugin__name), for example, `id="com.example.myplugin.myExtension"`. - `order` _(optional)_
Allows for ordering the extension relative to other instances of the same extension point. @@ -610,7 +612,7 @@ Attributes - `mac` - `unix` - `windows` - + For example, `os="windows"` registers the extension on Windows only. ### `extensionPoints` @@ -732,7 +734,7 @@ Example An extension point which restricts the type provided in a `myClass` attribute to be an instance of `com.example.ParentType`, and the type provided in a `someClass` element to be an instance of `java.lang.Comparable`: - + ```xml ``` - + When using the above extension point, an implementation could be registered as follows: - + ```xml com.example.MyComparable ``` - + where: - + - `com.example.MyCustomType` must be a subtype of `com.example.ParentType` - `com.example.MyComparable` must be a subtype of `java.lang.Comparable` @@ -1268,7 +1270,7 @@ Attributes - `ref` _(**required**)_
The ID of the action to add to a group. - `id` _(optional)_
- **_Deprecated_**: Use `ref` instead. + **_Deprecated_**: Use `ref` instead. The ID of the action to add to a group. diff --git a/topics/tutorials/live_templates/live_templates_configuration_file.md b/topics/tutorials/live_templates/live_templates_configuration_file.md index 50ad3a967..320de18e6 100644 --- a/topics/tutorials/live_templates/live_templates_configuration_file.md +++ b/topics/tutorials/live_templates/live_templates_configuration_file.md @@ -10,6 +10,8 @@ This page lists and describes all the elements and attributes used in live templ ## Configuration Structure Overview + + [//]: # (GENERATED CONTENT START) [//]: # (This content is generated by generate_descriptor_pages.main.kts script.)