From 62b214a804074c56ace2a3ed2e69b290aa35ba38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Wed, 12 Jun 2024 11:21:26 +0200 Subject: [PATCH] fix headings --- .../gradle_intellij_plugin/tools_gradle_intellij_plugin.md | 2 +- .../tools_gradle_intellij_plugin_faq.md | 2 +- .../ide_tooling/internal_actions/internal_ui_inspector.md | 6 +++--- .../tools_intellij_platform_gradle_plugin_faq.md | 2 +- topics/basics/getting_started/build_number_ranges.md | 2 +- topics/basics/persisting_state_of_components.md | 3 ++- topics/basics/plugin_structure/dynamic_plugins.md | 2 +- topics/reference_guide/project_model/module.md | 2 +- topics/reference_guide/project_model/project.md | 2 +- topics/user_interface_components/ui_faq.md | 4 ++-- 10 files changed, 14 insertions(+), 13 deletions(-) diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md index 13c37b1ad..0926654e8 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md @@ -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. -### 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. 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. diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md index 88c4421dd..52f86a460 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin_faq.md @@ -206,7 +206,7 @@ runPluginVerifier { -### 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: diff --git a/topics/appendix/tools/ide_tooling/internal_actions/internal_ui_inspector.md b/topics/appendix/tools/ide_tooling/internal_actions/internal_ui_inspector.md index a2d070a46..79d374d9b 100644 --- a/topics/appendix/tools/ide_tooling/internal_actions/internal_ui_inspector.md +++ b/topics/appendix/tools/ide_tooling/internal_actions/internal_ui_inspector.md @@ -1,6 +1,6 @@ -# Internal Actions - UI Inspector +# Internal Actions – UI Inspector UI Inspector allows checking properties of a component selected in the frame of running IDE instance. @@ -25,14 +25,14 @@ The _UI Inspector_ displays the icon details: ![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. _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 added-at 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 diff --git a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md index 7629eff85..7408e7f13 100644 --- a/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md +++ b/topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_faq.md @@ -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. -### 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: diff --git a/topics/basics/getting_started/build_number_ranges.md b/topics/basics/getting_started/build_number_ranges.md index 2e42e466c..17a875a5c 100644 --- a/topics/basics/getting_started/build_number_ranges.md +++ b/topics/basics/getting_started/build_number_ranges.md @@ -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 | | [231](https://github.com/JetBrains/intellij-community/tree/231) | 2023.1 | -#### Earlier versions +#### Earlier Versions {collapsible="true"} | Branch number | IntelliJ Platform version | diff --git a/topics/basics/persisting_state_of_components.md b/topics/basics/persisting_state_of_components.md index 2e2a06f4a..f4fe91386 100644 --- a/topics/basics/persisting_state_of_components.md +++ b/topics/basics/persisting_state_of_components.md @@ -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). See the example below. -#### Converter Example {collapsible="true"} +#### Converter Example +{collapsible="true"} ```java class LocalDateTimeConverter extends Converter { diff --git a/topics/basics/plugin_structure/dynamic_plugins.md b/topics/basics/plugin_structure/dynamic_plugins.md index 8f2a54ede..771c6a351 100644 --- a/topics/basics/plugin_structure/dynamic_plugins.md +++ b/topics/basics/plugin_structure/dynamic_plugins.md @@ -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). -### 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. diff --git a/topics/reference_guide/project_model/module.md b/topics/reference_guide/project_model/module.md index f36cd60a6..d745bc460 100644 --- a/topics/reference_guide/project_model/module.md +++ b/topics/reference_guide/project_model/module.md @@ -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. -### 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. A removal or rename of the `Module` will be tracked automatically. diff --git a/topics/reference_guide/project_model/project.md b/topics/reference_guide/project_model/project.md index 97acac20f..2b7a924f1 100644 --- a/topics/reference_guide/project_model/project.md +++ b/topics/reference_guide/project_model/project.md @@ -69,7 +69,7 @@ Messages.showInfoMessage("Source roots for the " + projectName + " 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: diff --git a/topics/user_interface_components/ui_faq.md b/topics/user_interface_components/ui_faq.md index 197375ec5..0a116c997 100644 --- a/topics/user_interface_components/ui_faq.md +++ b/topics/user_interface_components/ui_faq.md @@ -6,7 +6,7 @@ -## Useful classes +## Useful Classes - 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/) @@ -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. -## "Recently Used" entries +## "Recently Used" Entries 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).