mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 01:07:49 +08:00
Add information about descriptor files documentation provider
This commit is contained in:
parent
25b2248976
commit
11c4851dcf
@ -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
|
[dumb-aware]: https://img.shields.io/badge/-DumbAware-darkgreen?style=flat-square
|
||||||
|
|
||||||
</snippet>
|
</snippet>
|
||||||
|
|
||||||
|
<snippet id="descriptorDocumentationProviderNote">
|
||||||
|
|
||||||
|
> 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"}
|
||||||
|
|
||||||
|
</snippet>
|
||||||
|
@ -35,6 +35,8 @@ See also [](marketing.md) about widgets and badges.
|
|||||||
|
|
||||||
Deprecated elements are omitted in the list below.
|
Deprecated elements are omitted in the list below.
|
||||||
|
|
||||||
|
<include from="snippets.md" element-id="descriptorDocumentationProviderNote"/>
|
||||||
|
|
||||||
[//]: # (GENERATED CONTENT START)
|
[//]: # (GENERATED CONTENT START)
|
||||||
|
|
||||||
[//]: # (This content is generated by generate_descriptor_pages.main.kts script.)
|
[//]: # (This content is generated by generate_descriptor_pages.main.kts script.)
|
||||||
@ -586,7 +588,7 @@ Attributes
|
|||||||
`order`.
|
`order`.
|
||||||
<br/>
|
<br/>
|
||||||
To not clash with other plugins defining extensions with the same identifier,
|
To not clash with other plugins defining extensions with the same identifier,
|
||||||
consider prepending the identifier with a prefix related to the plugin [`<id>`](#idea-plugin__id) or
|
consider prepending the identifier with a prefix related to the plugin [`<id>`](#idea-plugin__id) or
|
||||||
[`<name>`](#idea-plugin__name), for example, `id="com.example.myplugin.myExtension"`.
|
[`<name>`](#idea-plugin__name), for example, `id="com.example.myplugin.myExtension"`.
|
||||||
- `order` _(optional)_<br/>
|
- `order` _(optional)_<br/>
|
||||||
Allows for ordering the extension relative to other instances of the same extension point.
|
Allows for ordering the extension relative to other instances of the same extension point.
|
||||||
@ -610,7 +612,7 @@ Attributes
|
|||||||
- `mac`
|
- `mac`
|
||||||
- `unix`
|
- `unix`
|
||||||
- `windows`
|
- `windows`
|
||||||
|
|
||||||
For example, `os="windows"` registers the extension on Windows only.
|
For example, `os="windows"` registers the extension on Windows only.
|
||||||
|
|
||||||
### `extensionPoints`
|
### `extensionPoints`
|
||||||
@ -732,7 +734,7 @@ Example
|
|||||||
An extension point which restricts the type provided in a `myClass` attribute to be an instance
|
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 `com.example.ParentType`, and the type provided in a `someClass` element to be an instance
|
||||||
of `java.lang.Comparable`:
|
of `java.lang.Comparable`:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<extensionPoint
|
<extensionPoint
|
||||||
name="myExtension"
|
name="myExtension"
|
||||||
@ -745,18 +747,18 @@ Example
|
|||||||
implements="java.lang.Comparable"/>
|
implements="java.lang.Comparable"/>
|
||||||
</extensionPoint>
|
</extensionPoint>
|
||||||
```
|
```
|
||||||
|
|
||||||
When using the above extension point, an implementation could be registered as follows:
|
When using the above extension point, an implementation could be registered as follows:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<myExtension ...
|
<myExtension ...
|
||||||
myClass="com.example.MyCustomType">
|
myClass="com.example.MyCustomType">
|
||||||
<someClass>com.example.MyComparable</someClass>
|
<someClass>com.example.MyComparable</someClass>
|
||||||
</myExtension>
|
</myExtension>
|
||||||
```
|
```
|
||||||
|
|
||||||
where:
|
where:
|
||||||
|
|
||||||
- `com.example.MyCustomType` must be a subtype of `com.example.ParentType`
|
- `com.example.MyCustomType` must be a subtype of `com.example.ParentType`
|
||||||
- `com.example.MyComparable` must be a subtype of `java.lang.Comparable`
|
- `com.example.MyComparable` must be a subtype of `java.lang.Comparable`
|
||||||
|
|
||||||
@ -1268,7 +1270,7 @@ Attributes
|
|||||||
- `ref` _(**required**)_<br/>
|
- `ref` _(**required**)_<br/>
|
||||||
The ID of the action to add to a group.
|
The ID of the action to add to a group.
|
||||||
- `id` _(optional)_<br/>
|
- `id` _(optional)_<br/>
|
||||||
**_Deprecated_**: Use `ref` instead.
|
**_Deprecated_**: Use `ref` instead.
|
||||||
|
|
||||||
The ID of the action to add to a group.
|
The ID of the action to add to a group.
|
||||||
|
|
||||||
|
@ -10,6 +10,8 @@ This page lists and describes all the elements and attributes used in live templ
|
|||||||
|
|
||||||
## Configuration Structure Overview
|
## Configuration Structure Overview
|
||||||
|
|
||||||
|
<include from="snippets.md" element-id="descriptorDocumentationProviderNote"/>
|
||||||
|
|
||||||
[//]: # (GENERATED CONTENT START)
|
[//]: # (GENERATED CONTENT START)
|
||||||
|
|
||||||
[//]: # (This content is generated by generate_descriptor_pages.main.kts script.)
|
[//]: # (This content is generated by generate_descriptor_pages.main.kts script.)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user