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 link-summary

Browse Source
This commit is contained in:
Karol Lewandowski 2022-12-08 13:05:04 +01:00
parent db99d82b8c
commit 3eabe8ebff
9 changed files with 29 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/basics/architectural_overview/psi_files.md
View File

@ -1,7 +1,9 @@
[//]: # (title: PSI Files)
# PSI Files
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>PSI File represents file content as a hierarchy of elements in a particular programming language.</link-summary>
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.
@ -11,7 +13,7 @@ Unlike `VirtualFile` and `Document`, which have application scope (even if multi
## How do I get a PSI file?
| 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) |

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

@ -2,6 +2,8 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Defining product compatibility by specifying plugin since-build and until-build ranges.</link-summary>
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 <path>[plugin.xml](plugin_configuration_file.md)</path> is managed by [`patchPluginXml`](tools_gradle_intellij_plugin.md#tasks-patchpluginxml) Gradle task, see [](configuring_plugin_project.md#patching-the-plugin-configuration-file).

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

@ -1,6 +1,8 @@
[//]: # (title: Dynamic Plugins)
# Dynamic Plugins
<!-- 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 contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Making a plugin dynamic allows installing, updating, and uninstalling it without IDE restart, as well as hot reloading plugin changes during the development.</link-summary>
Starting with the **2020.1** release, installing, updating, and uninstalling plugins without restarting the IDE is available in the IntelliJ Platform.

6
topics/basics/settings.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Settings)
# Settings
<!-- 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 contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Settings mechanism allows users to configure and persist application- or project-level plugin preferences.</link-summary>
<tldr>

4
topics/reference_guide/custom_language_support/code_completion.md
View File

@ -1,6 +1,8 @@
# Code Completion
<!-- 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 contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Implementing context-aware code completion in custom languages.</link-summary>
<tldr>

6
topics/reference_guide/custom_language_support/find_usages.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Find Usages)
# Find Usages
<!-- 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 contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Introduction to implementing Find Usages action in custom languages.</link-summary>
<tldr>

2
topics/tutorials/using_kotlin.md
View File

@ -2,6 +2,8 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Advantages and configuration required for developing a plugin in Kotlin.</link-summary>
<tldr>
**Homepage**: [Kotlin](https://kotlinlang.org)

4
topics/user_interface_components/kotlin_ui_dsl.md
View File

@ -1,9 +1,11 @@
[//]: # (title: Kotlin UI DSL Version 1)
# Kotlin UI DSL Version 1
<show-structure for="chapter" depth="2"/>
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Kotlin DSL for creating UI forms with input components bound to state object.</link-summary>
<tldr>
**Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout)

2
topics/user_interface_components/kotlin_ui_dsl_version_2.md
View File

@ -4,6 +4,8 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Kotlin DSL for creating UI forms with input components bound to state object.</link-summary>
<tldr>
**Platform UI Guidelines:** [Layout](https://jetbrains.design/intellij/principles/layout)