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

Add missing <link-summary>

Browse Source
This commit is contained in:
Karol Lewandowski 2023-03-31 14:22:25 +02:00
parent 86230f7af1
commit a91c10c36d
18 changed files with 95 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/appendix/tools/ide_tooling/internal_actions/internal_ui_laf_defaults.md
View File

@ -1,7 +1,9 @@
[//]: # (title: Internal Actions - LaF Defaults)
<!-- 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. --> <!-- 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. -->
# Internal Actions - LaF Defaults
<link-summary>Using LaF Defaults window to view and prototype UI control colors in a running IDE.</link-summary>
The <control>LaF Defaults</control> window provides a key-value pair lookup for UI Controls. The <control>LaF Defaults</control> window provides a key-value pair lookup for UI Controls.
It also allows interactive prototyping of UI Control color changes. It also allows interactive prototyping of UI Control color changes.

6
topics/appendix/tools/ide_tooling/internal_actions/internal_ui_sub.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Internal Actions - UI Submenu) <!-- 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. --> # Internal Actions - UI Submenu
<link-summary>Introduction to "Internal Actions | UI" submenu.</link-summary>
The Internal Actions UI submenu provides IntelliJ Platform plugin developers with a suite of tools to help develop, debug, and test their IntelliJ Platform project UI. The Internal Actions UI submenu provides IntelliJ Platform plugin developers with a suite of tools to help develop, debug, and test their IntelliJ Platform project UI.

6
topics/basics/basic_run_configurations.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Run Configurations) <!-- 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. --> # Run Configurations
<link-summary>Run configurations architecture overview.</link-summary>
<tldr> <tldr>

6
topics/basics/faq.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Plugin Development FAQ) <!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-202 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. --> # Plugin Development FAQ
<link-summary>List of plugin development forum topics with frequently asked question.</link-summary>
This FAQ is a topical index of questions that have been asked (and answered) on our [IntelliJ IDEA Open API and Plugin Development forum](https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development). This FAQ is a topical index of questions that have been asked (and answered) on our [IntelliJ IDEA Open API and Plugin Development forum](https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development).

8
topics/basics/persisting_sensitive_data.md
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. -->
# Persisting Sensitive Data # Persisting Sensitive Data
<!-- 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>Storing passwords, tokens and other sensitive data securely with Credentials Store API.</link-summary>
The Credentials Store API allows you to store sensitive user data securely, like passwords, server URLs, etc. The Credentials Store API allows you to store sensitive user data securely, like passwords, server URLs, etc.
@ -30,13 +32,13 @@ _Common Utility Method:_
// or get password only // or get password only
String password = PasswordSafe.getInstance().getPassword(credentialAttributes); String password = PasswordSafe.getInstance().getPassword(credentialAttributes);
``` ```
### Store Credentials ### Store Credentials
```java ```java
CredentialAttributes credentialAttributes = createCredentialAttributes(serverId); // see previous sample CredentialAttributes credentialAttributes =
createCredentialAttributes(serverId); // see previous sample
Credentials credentials = new Credentials(username, password); Credentials credentials = new Credentials(username, password);
PasswordSafe.getInstance().set(credentialAttributes, credentials); PasswordSafe.getInstance().set(credentialAttributes, credentials);
``` ```

6
topics/basics/plugin_types.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Plugin 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 contributors. Use of this source code is governed by the Apache 2.0 license. --> # Plugin Types
<link-summary>Overview and examples of different kinds of plugins.</link-summary>
Products based on the IntelliJ Platform can be modified and adjusted for custom purposes by adding plugins. Products based on the IntelliJ Platform can be modified and adjusted for custom purposes by adding plugins.
All downloadable plugins are available from the [JetBrains Marketplace](https://plugins.jetbrains.com/). All downloadable plugins are available from the [JetBrains Marketplace](https://plugins.jetbrains.com/).

6
topics/basics/testing_plugins/testing_highlighting.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Testing Highlighting) <!-- 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. --> # Testing Highlighting
<link-summary>Testing highlighting the code highlighted with various APIs.</link-summary>
When writing plugin tests, a common task is testing various kinds of highlighting (inspections, annotators, parser error highlighting, etc.). When writing plugin tests, a common task is testing various kinds of highlighting (inspections, annotators, parser error highlighting, etc.).
The IntelliJ Platform provides a dedicated utility and markup format for this task. The IntelliJ Platform provides a dedicated utility and markup format for this task.

6
topics/basics/testing_plugins/tests_and_fixtures.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Tests and Fixtures) <!-- 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. --> # Tests and Fixtures
<link-summary>Main approaches for implementing tests.</link-summary>
The IntelliJ Platform testing infrastructure is not tied to any specific test framework. The IntelliJ Platform testing infrastructure is not tied to any specific test framework.
In fact, the IntelliJ IDEA Team uses [JUnit](https://junit.org), [TestNG](https://testng.org), and [Cucumber](https://cucumber.io/) for testing different parts of the project. In fact, the IntelliJ IDEA Team uses [JUnit](https://junit.org), [TestNG](https://testng.org), and [Cucumber](https://cucumber.io/) for testing different parts of the project.

6
topics/products/phpstorm/php_open_api_breaking_changes.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Incompatible PHP OpenAPI Changes in PhpStorm) <!-- 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. --> # Incompatible PHP OpenAPI Changes in PhpStorm
<link-summary>Breaking PHP Open API changes page list.</link-summary>
The following pages list the breaking changes in IDE releases with required/recommended steps to take by plugin authors. The following pages list the breaking changes in IDE releases with required/recommended steps to take by plugin authors.

6
topics/products/phpstorm/php_open_api_breaking_changes_202.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Incompatible PHP OpenAPI changes in PhpStorm 2020.2) <!-- 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. --> # Incompatible PHP OpenAPI changes in PhpStorm 2020.2
<link-summary>List of known breaking PHP Open API changes in 2020.2.</link-summary>
## Union Types Support ## Union Types Support
PhpStorm 2020.2 introduced support for [PHP union types](https://wiki.php.net/rfc/union_types_v2), which resulted in some PSI-breaking changes. PhpStorm 2020.2 introduced support for [PHP union types](https://wiki.php.net/rfc/union_types_v2), which resulted in some PSI-breaking changes.

6
topics/products/phpstorm/php_open_api_breaking_changes_203.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Incompatible PHP OpenAPI changes in PhpStorm 2020.3) <!-- 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. --> # Incompatible PHP OpenAPI changes in PhpStorm 2020.3
<link-summary>List of known breaking PHP Open API changes in 2020.3.</link-summary>
## PHP 8 Support ## PHP 8 Support
PhpStorm 2020.3 introduces support for the upcoming PHP 8, which results in several noticeable changes in the PhpStorm internals. PhpStorm 2020.3 introduces support for the upcoming PHP 8, which results in several noticeable changes in the PhpStorm internals.

4
topics/reference_guide/custom_language_support/inlay_hints.md
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. -->
# Inlay Hints # Inlay Hints
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <link-summary>Providing additional code information directly in the editor without changing the document content.</link-summary>
<tldr> <tldr>

12
topics/reference_guide/localization_guide.md
View File

@ -1,12 +1,14 @@
[//]: # (title: Localization Guide) <!-- 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. --> # Localization Guide
<link-summary>Providing translations for IDE texts used in UI, inspections, file templates, etc.</link-summary>
The purpose of the document is to describe steps necessary to create localized versions of IDEA. The purpose of the document is to describe steps necessary to create localized versions of IDEA.
## Application Bundle Layout ## Application Bundle Layout
In regards to localization purpose all the resources (in English) that need to be translated are located in jar files called In regard to localization purpose all the resources (in English) that need to be translated are located in jar files called
<path>resources_en.jar</path>. <path>resources_en.jar</path>.
There's one such jar file for IDEA core functionality located at There's one such jar file for IDEA core functionality located at
<path>INSTALL_HOME\lib\resources_en.jar</path> <path>INSTALL_HOME\lib\resources_en.jar</path>
@ -14,7 +16,7 @@ and one jar for each of bundled plugins at
<path>INSTALL_HOME\plugins\$Plugin$\lib\resources_en.jar</path>. <path>INSTALL_HOME\plugins\$Plugin$\lib\resources_en.jar</path>.
Translated resources should be jarred and placed exactly in the same folder original jar comes from. Translated resources should be jarred and placed exactly in the same folder original jar comes from.
So localization pack should have exactly the same number of jar files and they have to be laid out in exactly the same way original jars are laid out. So localization pack should have exactly the same number of jar files, and they have to be laid out in exactly the same way original jars are laid out.
In order to enable multiple localizations per installation without localization packs overriding each other we suggest to include the name of the locale in the jar name (for example, ***resources_ja.jar***). In order to enable multiple localizations per installation without localization packs overriding each other we suggest to include the name of the locale in the jar name (for example, ***resources_ja.jar***).
## Content and Layout of resources_en.jar ## Content and Layout of resources_en.jar
@ -22,7 +24,7 @@ In order to enable multiple localizations per installation without localization
Property files usually contain messages, menu items, dialog labels texts etc. Property files usually contain messages, menu items, dialog labels texts etc.
For every such file localized jar should contain translated version that is placed to exactly the same path relative to the jar root and has exactly the same name as original file plus locale identifier. For every such file localized jar should contain translated version that is placed to exactly the same path relative to the jar root and has exactly the same name as original file plus locale identifier.
For example ***messages/ActionsBundle.properties*** file from ***resources_en.jar*** should have its translated version ***messages/ActionsBundle_ja.properties*** file in ***resources_ja.jar***. For example ***messages/ActionsBundle.properties*** file from ***resources_en.jar*** should have its translated version ***messages/ActionsBundle_ja.properties*** file in ***resources_ja.jar***.
All property files should be ASCII encoded with *\uXXXX* sequences used for characters that have no their representation in ASCII range. All property files should be ASCII encoded with *\uXXXX* sequences used for characters that have no representation in ASCII range.
See [native2ascii](https://docs.oracle.com/javase/7/docs/technotes/tools/solaris/native2ascii.html) tool for more details. See [native2ascii](https://docs.oracle.com/javase/7/docs/technotes/tools/solaris/native2ascii.html) tool for more details.
Property values mostly follow MessageFormat rules. Property values mostly follow MessageFormat rules.

6
topics/reference_guide/multiple_carets.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Multiple Carets) <!-- 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. --> # Multiple Carets
<link-summary>Working with multiple carets in a single editor.</link-summary>
<tldr> <tldr>

6
topics/user_interface_components/editor_components.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Editor Components) <!-- 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. --> # Editor Components
<link-summary>Creating, customizing and using editor components in different contexts.</link-summary>
## EditorTextField ## EditorTextField

6
topics/user_interface_components/lists_and_trees.md
View File

@ -1,6 +1,8 @@
[//]: # (title: List and Tree Controls) <!-- 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. --> # List and Tree Controls
<link-summary>Creating list and tree components consistent with IntelliJ Platform UI components.</link-summary>
### JBList and Tree ### JBList and Tree

8
topics/user_interface_components/popups.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Popups) <!-- 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 contributors. Use of this source code is governed by the Apache 2.0 license. --> # Popups
<link-summary>Creating different kinds of popups.</link-summary>
The IntelliJ Platform user interface makes extensive use of popups \- semi-modal windows that have no chrome (explicit closing buttons) and disappear automatically on focus loss. The IntelliJ Platform user interface makes extensive use of popups \- semi-modal windows that have no chrome (explicit closing buttons) and disappear automatically on focus loss.
Making use of these controls in your plugin ensures a consistent user experience between your plugin and the rest of the IDE. Making use of these controls in your plugin ensures a consistent user experience between your plugin and the rest of the IDE.
@ -11,7 +13,7 @@ The [`JBPopupFactory`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/ui
The most commonly used methods are: The most commonly used methods are:
| Method | Description | | Method | Description |
|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `createComponentPopupBuilder()` | Generic, allows showing any [Swing](https://docs.oracle.com/javase/tutorial/uiswing/start/index.html) component.<br/><br/>**Example**: [`IntentionPreviewPopupUpdateProcessor`](%gh-ic%/platform/lang-impl/src/com/intellij/codeInsight/intention/impl/preview/IntentionPreviewPopupUpdateProcessor.kt) creating a popup rendering the intention preview. | | `createComponentPopupBuilder()` | Generic, allows showing any [Swing](https://docs.oracle.com/javase/tutorial/uiswing/start/index.html) component.<br/><br/>**Example**: [`IntentionPreviewPopupUpdateProcessor`](%gh-ic%/platform/lang-impl/src/com/intellij/codeInsight/intention/impl/preview/IntentionPreviewPopupUpdateProcessor.kt) creating a popup rendering the intention preview. |
| `createPopupChooserBuilder()` | For choosing one or more items from a plain `java.util.List`.<br/><br/>**Example**: [`ShowMessageHistoryAction`](%gh-ic%/platform/vcs-impl/src/com/intellij/openapi/vcs/actions/ShowMessageHistoryAction.kt) creating a popup with recent commit messages history in the commit message text area. | | `createPopupChooserBuilder()` | For choosing one or more items from a plain `java.util.List`.<br/><br/>**Example**: [`ShowMessageHistoryAction`](%gh-ic%/platform/vcs-impl/src/com/intellij/openapi/vcs/actions/ShowMessageHistoryAction.kt) creating a popup with recent commit messages history in the commit message text area. |
| `createConfirmation()` | For choosing between two options, and performing different actions depending on which option is selected.<br/><br/>**Example**: [`VariableInplaceRenamer`](%gh-ic%/platform/lang-impl/src/com/intellij/refactoring/rename/inplace/VariableInplaceRenamer.java) creating confirmation popup after invalid variable name is provided in the inplace rename action. | | `createConfirmation()` | For choosing between two options, and performing different actions depending on which option is selected.<br/><br/>**Example**: [`VariableInplaceRenamer`](%gh-ic%/platform/lang-impl/src/com/intellij/refactoring/rename/inplace/VariableInplaceRenamer.java) creating confirmation popup after invalid variable name is provided in the inplace rename action. |

4
topics/user_interface_components/user_interface_components.md
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. -->
# User Interface Components # User Interface Components
<!-- 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>Introduction to UI Components provided by IntelliJ Platform.</link-summary>
<tldr> <tldr>