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

fix headings

Browse Source
This commit is contained in:
Yann Cébron 2024-06-12 11:21:26 +02:00
parent 4b62ec4030
commit 62b214a804
10 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md
View File

@ -185,7 +185,7 @@ org.gradle.unsafe.configuration-cache = true
See [Using the configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html#config_cache:usage) in the Gradle documentation for more details. See [Using the configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html#config_cache:usage) in the Gradle documentation for more details.
### Multi-module Project ### Multi-Module Project
Sometimes, you may want to split your plugin into multiple modules — i.e., to separate the core plugin code from the code related to other third-party plugin dependencies. Sometimes, you may want to split your plugin into multiple modules — i.e., to separate the core plugin code from the code related to other third-party plugin dependencies.
The most common way to do this is to use the [Gradle Multi-Project Build](https://docs.gradle.org/current/userguide/multi_project_builds.html) feature. The most common way to do this is to use the [Gradle Multi-Project Build](https://docs.gradle.org/current/userguide/multi_project_builds.html) feature.

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

@ -206,7 +206,7 @@ runPluginVerifier {
</tabs> </tabs>
### JaCoCo reports 0% coverage ### JaCoCo Reports 0% Coverage
The Gradle IntelliJ Plugin, when targeting the IntelliJ SDK `2022.1+`, uses the `PathClassLoader` class loader by the following system property: The Gradle IntelliJ Plugin, when targeting the IntelliJ SDK `2022.1+`, uses the `PathClassLoader` class loader by the following system property:

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

@ -1,6 +1,6 @@
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Internal Actions - UI Inspector # Internal Actions – UI Inspector
<link-summary>UI Inspector allows checking properties of a component selected in the frame of running IDE instance.</link-summary> <link-summary>UI Inspector allows checking properties of a component selected in the frame of running IDE instance.</link-summary>
@ -25,14 +25,14 @@ The _UI Inspector_ displays the icon details:
![Internal Icon Info](internal_ui_inspector_icon_info.png) ![Internal Icon Info](internal_ui_inspector_icon_info.png)
## added-at Property ## `added-at` Property
Sometimes, inspecting complex component's properties is not enough to understand how the component was created and configured. Sometimes, inspecting complex component's properties is not enough to understand how the component was created and configured.
_UI Inspector_ gives the possibility of finding the code where the selected component was added, which makes it much easier to understand which APIs can be used to build custom components with similar complexity. _UI Inspector_ gives the possibility of finding the code where the selected component was added, which makes it much easier to understand which APIs can be used to build custom components with similar complexity.
To find the place were component was added, select the <control>added-at</control> property to show the stacktrace: To find the place were component was added, select the <control>added-at</control> property to show the stacktrace:
![added-at Stacktrace](internal_ui_inspector_added_at.png) ![added-at stack trace](internal_ui_inspector_added_at.png)
## Specific Component Properties ## Specific Component Properties

2
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md
View File

@ -80,7 +80,7 @@ See [Migrating from Gradle IntelliJ Plugin](tools_intellij_platform_gradle_plugi
See the [](bundling_plugin_openapi_sources.md) section for details. See the [](bundling_plugin_openapi_sources.md) section for details.
### JaCoCo reports 0% coverage ### JaCoCo Reports 0% Coverage
The Gradle IntelliJ Plugin, when targeting the IntelliJ SDK `2022.1+`, uses the `PathClassLoader` class loader by the following system property: The Gradle IntelliJ Plugin, when targeting the IntelliJ SDK `2022.1+`, uses the `PathClassLoader` class loader by the following system property:

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

@ -99,7 +99,7 @@ In the `YYYY.R` versioning scheme, the `R` part starts at 1.
| [232](https://github.com/JetBrains/intellij-community/tree/232) | 2023.2 | | [232](https://github.com/JetBrains/intellij-community/tree/232) | 2023.2 |
| [231](https://github.com/JetBrains/intellij-community/tree/231) | 2023.1 | | [231](https://github.com/JetBrains/intellij-community/tree/231) | 2023.1 |
#### Earlier versions #### Earlier Versions
{collapsible="true"} {collapsible="true"}
| Branch number | IntelliJ Platform version | | Branch number | IntelliJ Platform version |

3
topics/basics/persisting_state_of_components.md
View File

@ -131,7 +131,8 @@ The following types of values can be persisted:
For other types, extend [`Converter`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/api.kt). For other types, extend [`Converter`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/api.kt).
See the example below. See the example below.
#### Converter Example {collapsible="true"} #### Converter Example
{collapsible="true"}
```java ```java
class LocalDateTimeConverter extends Converter<LocalDateTime> { class LocalDateTimeConverter extends Converter<LocalDateTime> {

2
topics/basics/plugin_structure/dynamic_plugins.md
View File

@ -63,7 +63,7 @@ Application, project, and module [services](plugin_services.md) declared with `o
Loading/Unloading a plugin clears all cached values created using [`CachedValuesManager`](%gh-ic%/platform/core-api/src/com/intellij/psi/util/CachedValuesManager.java). Loading/Unloading a plugin clears all cached values created using [`CachedValuesManager`](%gh-ic%/platform/core-api/src/com/intellij/psi/util/CachedValuesManager.java).
### Do not Store PSI ### Don't Store PSI
Do not store references to PSI elements in objects which can survive plugin loading or unloading; use [`SmartPsiElementPointer`](%gh-ic%/platform/core-api/src/com/intellij/psi/SmartPsiElementPointer.java) instead. Do not store references to PSI elements in objects which can survive plugin loading or unloading; use [`SmartPsiElementPointer`](%gh-ic%/platform/core-api/src/com/intellij/psi/SmartPsiElementPointer.java) instead.

2
topics/reference_guide/project_model/module.md
View File

@ -113,7 +113,7 @@ String moduleName = module == null ? "Module not found" : module.getName();
* To get the project module to which the specified [PSI element](psi_elements.md) belongs, use the `ModuleUtil.findModuleForPsiElement()` method. * To get the project module to which the specified [PSI element](psi_elements.md) belongs, use the `ModuleUtil.findModuleForPsiElement()` method.
### Storing a reference to a Module ### Storing a Reference to a Module
Use [`ModulePointer`](%gh-ic%/platform/projectModel-api/src/com/intellij/openapi/module/ModulePointer.java) to store a reference to a `Module` by its instance or name. Use [`ModulePointer`](%gh-ic%/platform/projectModel-api/src/com/intellij/openapi/module/ModulePointer.java) to store a reference to a `Module` by its instance or name.
A removal or rename of the `Module` will be tracked automatically. A removal or rename of the `Module` will be tracked automatically.

2
topics/reference_guide/project_model/project.md
View File

@ -69,7 +69,7 @@ Messages.showInfoMessage("Source roots for the " + projectName +
" plugin:\n" + sourceRootsList, "Project Properties"); " plugin:\n" + sourceRootsList, "Project Properties");
``` ```
### Checking if a File Belongs to a Project ### Checking If a File Belongs to a Project
Use [`ProjectFileIndex`](%gh-ic%/platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) to get this information: Use [`ProjectFileIndex`](%gh-ic%/platform/projectModel-api/src/com/intellij/openapi/roots/ProjectFileIndex.java) to get this information:

4
topics/user_interface_components/ui_faq.md
View File

@ -6,7 +6,7 @@
<include from="user_interface_components.md" element-id="inspectingExistingUI"/> <include from="user_interface_components.md" element-id="inspectingExistingUI"/>
## Useful classes ## Useful Classes
- Package [`com.intellij.ui`](%gh-ic%/platform/util/ui/src/com/intellij/ui/) - Package [`com.intellij.ui`](%gh-ic%/platform/util/ui/src/com/intellij/ui/)
- Package [`com.intellij.util.ui`](%gh-ic%/platform/util/ui/src/com/intellij/util/ui/) - Package [`com.intellij.util.ui`](%gh-ic%/platform/util/ui/src/com/intellij/util/ui/)
@ -52,7 +52,7 @@ See [](internationalization.md) for information about internationalizing plugins
See [`NlsMessages`](%gh-ic%/platform/ide-core-impl/src/com/intellij/ide/nls/NlsMessages.java) to produce localized messages. See [`NlsMessages`](%gh-ic%/platform/ide-core-impl/src/com/intellij/ide/nls/NlsMessages.java) to produce localized messages.
## "Recently Used" entries ## "Recently Used" Entries
To store and retrieve values for *Recently Used* entries (e.g., filter values), use To store and retrieve values for *Recently Used* entries (e.g., filter values), use
[`RecentsManager`](%gh-ic%/platform/platform-impl/src/com/intellij/ui/RecentsManager.java). [`RecentsManager`](%gh-ic%/platform/platform-impl/src/com/intellij/ui/RecentsManager.java).