diff --git a/topics/basics/architectural_overview/psi_files.md b/topics/basics/architectural_overview/psi_files.md index 6c2cc04f9..89484e8ea 100644 --- a/topics/basics/architectural_overview/psi_files.md +++ b/topics/basics/architectural_overview/psi_files.md @@ -1,7 +1,9 @@ -[//]: # (title: PSI Files) +# PSI Files +PSI File represents file content as a hierarchy of elements in a particular programming language. + A PSI (Program Structure Interface) file is the root of a structure representing a file's contents as a hierarchy of elements in a particular programming language. The [`PsiFile`](%gh-ic%/platform/core-api/src/com/intellij/psi/PsiFile.java) class is the common base class for all PSI files, while files in a specific language are usually represented by its subclasses. For example, the [`PsiJavaFile`](%gh-ic%/java/java-psi-api/src/com/intellij/psi/PsiJavaFile.java) class represents a Java file, and the [`XmlFile`](%gh-ic%/xml/xml-psi-api/src/com/intellij/psi/xml/XmlFile.java) class represents an XML file. @@ -10,8 +12,8 @@ Unlike `VirtualFile` and `Document`, which have application scope (even if multi ## How do I get a PSI file? -| Context | API | -|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Context | API | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Action](basic_action_system.md) | [`AnActionEvent.getData(CommonDataKeys.PSI_FILE)`](%gh-ic%/platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnActionEvent.java) | | [Document](documents.md) | [`PsiDocumentManager.getInstance(project).getPsiFile()`](%gh-ic%/platform/core-api/src/com/intellij/psi/PsiDocumentManager.java) | | [PSI Element](psi_elements.md) | [`PsiElement.getContainingFile()`](%gh-ic%/platform/core-api/src/com/intellij/psi/PsiElement.java) (may return `null` if the PSI element is not contained in a file) | diff --git a/topics/basics/getting_started/build_number_ranges.md b/topics/basics/getting_started/build_number_ranges.md index 3cc37aa58..b48198137 100644 --- a/topics/basics/getting_started/build_number_ranges.md +++ b/topics/basics/getting_started/build_number_ranges.md @@ -2,6 +2,8 @@ +Defining product compatibility by specifying plugin since-build and until-build ranges. + Use this reference of build number ranges to specify the correct `since-build` and `until-build` values in your plugin descriptor. Setting the actual values in [plugin.xml](plugin_configuration_file.md) is managed by [`patchPluginXml`](tools_gradle_intellij_plugin.md#tasks-patchpluginxml) Gradle task, see [](configuring_plugin_project.md#patching-the-plugin-configuration-file). diff --git a/topics/basics/plugin_structure/dynamic_plugins.md b/topics/basics/plugin_structure/dynamic_plugins.md index b976c7b05..e74206481 100644 --- a/topics/basics/plugin_structure/dynamic_plugins.md +++ b/topics/basics/plugin_structure/dynamic_plugins.md @@ -1,6 +1,8 @@ -[//]: # (title: Dynamic Plugins) +# Dynamic Plugins - + + +Making a plugin dynamic allows installing, updating, and uninstalling it without IDE restart, as well as hot reloading plugin changes during the development. Starting with the **2020.1** release, installing, updating, and uninstalling plugins without restarting the IDE is available in the IntelliJ Platform. diff --git a/topics/basics/settings.md b/topics/basics/settings.md index 705c64a16..fd9db55ce 100644 --- a/topics/basics/settings.md +++ b/topics/basics/settings.md @@ -1,6 +1,8 @@ -[//]: # (title: Settings) +# Settings - + + +Settings mechanism allows users to configure and persist application- or project-level plugin preferences. diff --git a/topics/reference_guide/custom_language_support/code_completion.md b/topics/reference_guide/custom_language_support/code_completion.md index 0e9ae12e6..afae24714 100644 --- a/topics/reference_guide/custom_language_support/code_completion.md +++ b/topics/reference_guide/custom_language_support/code_completion.md @@ -1,6 +1,8 @@ # Code Completion - + + +Implementing context-aware code completion in custom languages. diff --git a/topics/reference_guide/custom_language_support/find_usages.md b/topics/reference_guide/custom_language_support/find_usages.md index a3af8989a..ed807ad0b 100644 --- a/topics/reference_guide/custom_language_support/find_usages.md +++ b/topics/reference_guide/custom_language_support/find_usages.md @@ -1,6 +1,8 @@ -[//]: # (title: Find Usages) +# Find Usages - + + +Introduction to implementing Find Usages action in custom languages. diff --git a/topics/tutorials/using_kotlin.md b/topics/tutorials/using_kotlin.md index cd8262c8b..ea23d1aca 100644 --- a/topics/tutorials/using_kotlin.md +++ b/topics/tutorials/using_kotlin.md @@ -2,6 +2,8 @@ +Advantages and configuration required for developing a plugin in Kotlin. + **Homepage**: [Kotlin](https://kotlinlang.org) diff --git a/topics/user_interface_components/kotlin_ui_dsl.md b/topics/user_interface_components/kotlin_ui_dsl.md index ec38e7e62..1310e7267 100644 --- a/topics/user_interface_components/kotlin_ui_dsl.md +++ b/topics/user_interface_components/kotlin_ui_dsl.md @@ -1,9 +1,11 @@ -[//]: # (title: Kotlin UI DSL Version 1) +# Kotlin UI DSL Version 1 +Kotlin DSL for creating UI forms with input components bound to state object. + **Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout) diff --git a/topics/user_interface_components/kotlin_ui_dsl_version_2.md b/topics/user_interface_components/kotlin_ui_dsl_version_2.md index 9571b9cc4..2302c1a45 100644 --- a/topics/user_interface_components/kotlin_ui_dsl_version_2.md +++ b/topics/user_interface_components/kotlin_ui_dsl_version_2.md @@ -4,6 +4,8 @@ +Kotlin DSL for creating UI forms with input components bound to state object. + **Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout)