mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-27 16:57:49 +08:00
Add pages link-summary
This commit is contained in:
parent
369c534de0
commit
79e97c2564
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Bundling Plugin API Sources)
|
||||
|
||||
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Exposing plugin's API sources for other plugins.</link-summary>
|
||||
|
||||
If a plugin exposes its own API that is meant to be used by other plugins, it is worth considering bundling the plugin's API sources in the ZIP distribution.
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Disposer and Disposable)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Cleaning up resources on plugin components' lifetime expiration.</link-summary>
|
||||
|
||||
The IntelliJ Platform's [`Disposer`](%gh-ic%/platform/util/src/com/intellij/openapi/util/Disposer.java) facilitates resource cleanup.
|
||||
If a subsystem keeps a set of resources alive coincident with a parent object's lifetime, the subsystem's resources should be registered with the `Disposer` to be released before or at the same time as the parent object.
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Components)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Migrating deprecated plugin components to the current solutions.</link-summary>
|
||||
|
||||
> When writing new plugins, creating Components should be avoided.
|
||||
> Any existing Components should be migrated to services, extensions, or listeners (see below).
|
||||
|
@ -1,6 +1,8 @@
|
||||
# Extension Points
|
||||
|
||||
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Allowing to extend plugin's functionality by other plugins.</link-summary>
|
||||
|
||||
> See [Plugin Extensions](plugin_extensions.md) for _using_ extension points in your plugin.
|
||||
>
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Test Project and Testdata Directories)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Adding test data to test projects used during tests execution.</link-summary>
|
||||
|
||||
The test fixture creates a *test project* environment.
|
||||
Unless you customize the project creation, the test project will have one module with one source root called <path>src</path>.
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Code Inspections and Intentions)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Introduction to analysing the code and providing quick fixes for the found issues.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: References and Resolve)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>PSI references allow for resolving from a symbol usage to its declaration.</link-summary>
|
||||
|
||||
One of the most important and tricky parts in implementing a custom language PSI is resolving references.
|
||||
Resolving references gives users the ability to navigate from a PSI element usage (accessing a variable, calling a method, etc.) to the declaration of that element (the variable's definition, a method declaration, and so on).
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: IntelliJ Platform Artifacts Repositories)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Overview of the repositories hosting artifacts related to the IntelliJ Platform.</link-summary>
|
||||
|
||||
> When using additional repositories, make sure to use HTTPS always.
|
||||
>
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Messaging Infrastructure)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Subscribing and publishing messages via message bus.</link-summary>
|
||||
|
||||
## Purpose
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Intentions)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Intention actions allowing to fix code issues or transform the code to a different form.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: 7. Annotator)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Sample implementation of annotator highlighting resolved and unresolved Simple language properties in Java strings.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: 4. Lexer and Parser Definition)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Sample implementation of Simple language lexer and parser.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
|
@ -1,6 +1,8 @@
|
||||
[//]: # (title: Tool Windows)
|
||||
|
||||
<!-- 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-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||||
|
||||
<link-summary>Displaying additional information and controls in child windows of the IDE.</link-summary>
|
||||
|
||||
<tldr>
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user