Add missing <link-summary>

This commit is contained in:
Karol Lewandowski 2023-04-04 11:59:37 +02:00
parent e8976d4ec0
commit 503be53f00
19 changed files with 84 additions and 48 deletions

View File

@ -1,6 +1,8 @@
[//]: # (title: JetBrains Marketplace) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # JetBrains Marketplace
<link-summary>Overview of key JetBrains Marketplace Documentation topics.</link-summary>
JetBrains provides an official plugin repository [JetBrains Marketplace](https://plugins.jetbrains.com) for all IntelliJ Platform-based IDEs, as well as other products. JetBrains provides an official plugin repository [JetBrains Marketplace](https://plugins.jetbrains.com) for all IntelliJ Platform-based IDEs, as well as other products.

View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Consulting # Consulting
<!-- 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. --> <link-summary>List of independent companies and individuals providing paid plugin consulting and development services.</link-summary>
The following independent companies and individuals provide paid plugin consulting and development services. The following independent companies and individuals provide paid plugin consulting and development services.
@ -8,17 +10,17 @@ Also, consider posting requests in _#jobs_ channel on [JetBrains Platform Slack]
> JetBrains is not responsible for nor guarantees the performance of these independent third-party companies. > JetBrains is not responsible for nor guarantees the performance of these independent third-party companies.
| Name | Contact | Notes | | Name | Contact | Notes |
|--------------------|---------------------------------------------------------|---------------------------------------------| |--------------------|---------------------------------------------------------|------------------------------------------------------------------------------|
| Joachim Ansorg | [www.plugin-dev.com][ja] | -/- | | Joachim Ansorg | [www.plugin-dev.com][ja] | -/- |
| Daniel Espendiller | [daniel@espendiller.net][de] | -/- | | Daniel Espendiller | [daniel@espendiller.net][de] | -/- |
| Robert Ekendahl | [www.edaphic.studio][re] | Custom Language support | | Robert Ekendahl | [www.edaphic.studio][re] | Custom Language support |
| Alexey Stukalov | [info@jpa-buddy.com][ast], [www.haulmont.com][ast2] | Plugins: [CUBA][ast3], [JPA Buddy][ast4], [React Buddy][ast5], [Jmix][ast6].| | Alexey Stukalov | [info@jpa-buddy.com][ast], [www.haulmont.com][ast2] | Plugins: [CUBA][ast3], [JPA Buddy][ast4], [React Buddy][ast5], [Jmix][ast6]. |
| Edument | [jonathan@edument.cz][ed], [edument.se][ed2] | Developers of [Comma IDE][ed3] | | Edument | [jonathan@edument.cz][ed], [edument.se][ed2] | Developers of [Comma IDE][ed3] |
| Mikhail Bolotov | [mikhail.bolotov@gmail.com][mb] | Plugins: [Cypress Support Pro][cspro], [k6] | | Mikhail Bolotov | [mikhail.bolotov@gmail.com][mb] | Plugins: [Cypress Support Pro][cspro], [k6] |
| Ilscipio GmbH | [Paul Piper][il], [www.ilscipio.com][il2] | Custom Plugin Development | | Ilscipio GmbH | [Paul Piper][il], [www.ilscipio.com][il2] | Custom Plugin Development |
| Tamás Balog | [www.picimako.com][pm] | Custom Plugin Development | | Tamás Balog | [www.picimako.com][pm] | Custom Plugin Development |
| Jacky Liu | [beansoft@126.com][bn], [Marketplace of BeanSoft][bn2] | Custom Plugin Development, Plugins: [React Native Console][rnc] | | Jacky Liu | [beansoft@126.com][bn], [Marketplace of BeanSoft][bn2] | Custom Plugin Development, Plugins: [React Native Console][rnc] |
[ja]: https://www.plugin-dev.com [ja]: https://www.plugin-dev.com
[de]: mailto:daniel@espendiller.net [de]: mailto:daniel@espendiller.net

View File

@ -2,6 +2,8 @@
# Analyzing # Analyzing
<link-summary>The Analyzing section overview.</link-summary>
* [](syntax_errors.md) * [](syntax_errors.md)
* Annotator * Annotator
* [Inspections](code_inspections.md) * [Inspections](code_inspections.md)

View File

@ -1,6 +1,8 @@
[//]: # (title: Files) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Files
<link-summary>The Files section overview.</link-summary>
* [Virtual File System](virtual_file_system.md) * [Virtual File System](virtual_file_system.md)
* [Virtual Files](virtual_file.md) * [Virtual Files](virtual_file.md)

View File

@ -2,6 +2,8 @@
# Modifying the PSI # Modifying the PSI
<link-summary>Creating, deleting, and modifying PSI elements.</link-summary>
The PSI is a read/write representation of the source code as a tree of elements corresponding to a source file's structure. The PSI is a read/write representation of the source code as a tree of elements corresponding to a source file's structure.
You can modify the PSI by *adding*, *replacing*, and *deleting* PSI elements. You can modify the PSI by *adding*, *replacing*, and *deleting* PSI elements.

View File

@ -1,6 +1,8 @@
[//]: # (title: Editing) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Editing
<link-summary>The Editing section overview.</link-summary>
* Code Completion * Code Completion
* [](postfix_completion.md) * [](postfix_completion.md)

View File

@ -1,6 +1,8 @@
[//]: # (title: Actions) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Actions
<link-summary>Introduction to actions allowing to invoke plugin functionalities.</link-summary>
The IntelliJ Platform provides the concept of _actions_. The IntelliJ Platform provides the concept of _actions_.
An action is a class derived from [`AnAction`](%gh-ic%/platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java), whose `actionPerformed()` method is called when its menu item or toolbar button is selected. An action is a class derived from [`AnAction`](%gh-ic%/platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java), whose `actionPerformed()` method is called when its menu item or toolbar button is selected.

View File

@ -1,7 +1,7 @@
# Plugin User Experience (UX)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Plugin User Experience (UX)
<link-summary>Ensuring a good user experience for your plugin.</link-summary> <link-summary>Ensuring a good user experience for your plugin.</link-summary>
_User Experience (UX)_ is a term describing the experience users feel when using a product. _User Experience (UX)_ is a term describing the experience users feel when using a product.

View File

@ -1,6 +1,8 @@
[//]: # (title: Project View) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Project View
<link-summary>Changing the project view nodes representation.</link-summary>
<tldr> <tldr>

View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# SDK Code Sample Guidelines # SDK Code Sample Guidelines
<!-- 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. --> <link-summary>Coding guidelines for the code contributed to the IntelliJ SDK Code Samples.</link-summary>
This document describes the coding guidelines used for authoring open-source IntelliJ Platform SDK code samples. This document describes the coding guidelines used for authoring open-source IntelliJ Platform SDK code samples.
Before you begin, please read this page thoroughly, as well as the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md) and [License](https://github.com/JetBrains/intellij-sdk-docs/blob/main/LICENSE.txt) documents. Before you begin, please read this page thoroughly, as well as the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md) and [License](https://github.com/JetBrains/intellij-sdk-docs/blob/main/LICENSE.txt) documents.

View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# IntelliJ IDEA Ultimate # IntelliJ IDEA Ultimate
<!-- 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. --> <link-summary>The IntelliJ IDEA Ultimate section overview.</link-summary>
<var name="productID" value="idea"/> <var name="productID" value="idea"/>
<var name="marketplaceProductID" value="idea"/> <var name="marketplaceProductID" value="idea"/>

View File

@ -1,6 +1,8 @@
[//]: # (title: PHP Type Providers) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # PHP Type Providers
<link-summary>Providing element type information for PHP type inference mechanism.</link-summary>
Type inference in PhpStorm is built on top of type providers, each of which is responsible for inferring the types of Type inference in PhpStorm is built on top of type providers, each of which is responsible for inferring the types of
specific PSI elements. specific PSI elements.
@ -13,7 +15,7 @@ All providers inherit from `com.jetbrains.php.lang.psi.resolve.types.PhpTypeProv
The first phase of type inference takes place at the indexing stage. The first phase of type inference takes place at the indexing stage.
At this phase, PhpStorm calls `PhpTypeProvider4.getType()` on each type provider. At this phase, PhpStorm calls `PhpTypeProvider4.getType()` on each type provider.
PhpStorm only has access to local information from the current file and can't use information from other files as well as indexes because it does't yet build them. PhpStorm only has access to local information from the current file and can't use information from other files as well as indexes because it doesn't yet build them.
Sometimes, it can deduce the exact type from this information, but in other cases this is impossible because PhpStorm requires information from other files. Sometimes, it can deduce the exact type from this information, but in other cases this is impossible because PhpStorm requires information from other files.
Because of this, there are two kinds of types in PhpStorm: Because of this, there are two kinds of types in PhpStorm:
@ -21,7 +23,7 @@ Because of this, there are two kinds of types in PhpStorm:
- Complete types - Complete types
- Incomplete types - Incomplete types
### Complete types ### Complete Types
Complete types are types that are known exactly based on **only** the local information of the current file. Complete types are types that are known exactly based on **only** the local information of the current file.
@ -43,7 +45,7 @@ function foo(string $a): string {
Here, since the `$a` parameter has a `string` type hint, PhpStorm can infer the Complete type `string`. Here, since the `$a` parameter has a `string` type hint, PhpStorm can infer the Complete type `string`.
### Incomplete types ### Incomplete Types
Incomplete types are types that need additional information from other project files besides the containing file. Incomplete types are types that need additional information from other project files besides the containing file.

View File

@ -1,6 +1,8 @@
[//]: # (title: Editors) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Editors
<link-summary>The Editors section overview.</link-summary>
This section covers working with text in the IntelliJ Platform editor. This section covers working with text in the IntelliJ Platform editor.
It is presented in two major sections: It is presented in two major sections:
@ -10,4 +12,4 @@ It is presented in two major sections:
* Handling actions activated by keystroke events in the editor. * Handling actions activated by keystroke events in the editor.
* [Multiple carets](multiple_carets.md) * [Multiple carets](multiple_carets.md)
* Working with multiple, independent, carets in one editor. * Working with multiple, independent, carets in one editor.
* How multiple carets affect core functionality, editor actions, typing actions, and code insight actions. * How multiple carets affect core functionality, editor actions, typing actions, and code insight actions.

View File

@ -1,5 +1,7 @@
[//]: # (title: Build System) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Build System
* [External builder API and plugins](external_builder_api.md) <link-summary>The Analyzing section overview.</link-summary>
* [External builder API and plugins](external_builder_api.md)

View File

@ -1,6 +1,8 @@
[//]: # (title: Trusted Project) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Trusted Project
<link-summary>Preventing executing malicious code in untrusted projects.</link-summary>
<tldr> <tldr>

View File

@ -1,6 +1,8 @@
[//]: # (title: Project Wizard - Adding Support for Creating New Project Types) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Project Wizard - Adding Support for Creating New Project Types
<link-summary>Implementing a custom project creation wizard.</link-summary>
## Project Wizard ## Project Wizard

View File

@ -1,6 +1,8 @@
[//]: # (title: Text Selection) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Text Selection
<link-summary>Providing additional text ranges used when a text selection is extended/shrank.</link-summary>
## Extending/Shrinking Text Selection ## Extending/Shrinking Text Selection

View File

@ -1,6 +1,8 @@
[//]: # (title: Frameworks) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Frameworks
<link-summary>Tutorial on implementing custom framework types.</link-summary>
The following tutorial shows how to support a custom framework type for a project and make this framework type embedded in a project wizard as a UI component. The following tutorial shows how to support a custom framework type for a project and make this framework type embedded in a project wizard as a UI component.
The examples in this tutorial rely heavily on the [framework_basics](%gh-sdk-samples%/framework_basics) code sample. The examples in this tutorial rely heavily on the [framework_basics](%gh-sdk-samples%/framework_basics) code sample.

View File

@ -1,6 +1,8 @@
[//]: # (title: Project Wizard Tutorial) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. --> # Project Wizard Tutorial
<link-summary>The Project Wizard Tutorial section overview.</link-summary>
This set of tutorials shows how to manipulate the process of project creation. This set of tutorials shows how to manipulate the process of project creation.
Configuring Project Wizard automatically allows you to do the following: Configuring Project Wizard automatically allows you to do the following: