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

Browse Source
This commit is contained in:
Karol Lewandowski 2023-03-24 11:00:19 +01:00
parent 6334253a4c
commit 83b281b63c
15 changed files with 52 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
topics/basics/indexing_and_psi_stubs/file_based_indexes.md
View File

@ -1,6 +1,8 @@
[//]: # (title: File-Based Indexes)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. -->
# File-Based Indexes
<link-summary>Introduction to file-based indexes allowing to store information about presence of some values in files, and accessing it by keys in a performant way.</link-summary>
File-based indexes are based on a [Map/Reduce architecture](https://en.wikipedia.org/wiki/MapReduce).
Each index has a specific type of key and a particular type of value.

6
topics/basics/testing_plugins/light_and_heavy_tests.md
View File

@ -1,6 +1,8 @@
[//]: # (title: Light and Heavy Tests)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. -->
# Light and Heavy Tests
<link-summary>Introduction to light tests reusing a single project for multiple tests, and heavy tests creating a new project for each test.</link-summary>
Plugin tests run in a real, rather than mocked, IntelliJ Platform environment and use real implementations for most application and project [services](plugin_services.md).

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

@ -1,6 +1,8 @@
[//]: # (title: Declarations and References)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. -->
# Declarations and References
<link-summary>Overview of symbol declarations and references.</link-summary>
> This API is available starting from 2020.3 and is currently in development and thus in an experimental state.
>

7
topics/reference_guide/custom_language_support/parameter_info.md
View File

@ -1,6 +1,9 @@
[//]: # (title: Parameter Info)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Parameter Info
<link-summary>Implementing parameter info handler allowing to display method/function parameter names and types before providing actual values.</link-summary>
<!-- 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. -->
<tldr>
**Product Help:** [Parameter info](https://www.jetbrains.com/help/idea/viewing-reference-information.html#view-parameter-info)

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

@ -1,6 +1,8 @@
[//]: # (title: Registering a File Type)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. -->
# Registering a File Type
<link-summary>Registering a language file type associating file extensions and patterns with a language.</link-summary>
<tldr>

7
topics/reference_guide/frameworks_and_external_apis/xml_dom_api.md
View File

@ -1,9 +1,10 @@
[//]: # (title: XML DOM API)
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- 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. -->
# XML DOM API
<!-- TODO content: DOM <=> PSI, Go To Symbol, editor gutter icon->DOM -->
<link-summary>Implementing APIs for accessing XML models.</link-summary>
[//]: # (TODO content: DOM <=> PSI, Go To Symbol, editor gutter icon->DOM)
This article is intended for plugin writers who create custom web server integrations, or some UI for easy XML editing.
It describes the *Document Object Model* (DOM) in IntelliJ Platform - an easy way to work with DTD or Schema-based XML models.

4
topics/tutorials/writing_tests_for_plugins/annotator_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 4. Annotator Test
<!-- 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 and running tests for the annotator implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/commenter_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 9. Commenter Test
<!-- 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 and running test for the commenter implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/documentation_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 11. Documentation Test
<!-- 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 and running test for documentation provider implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/find_usages_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 8. Find Usages Test
<!-- 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 and running test for finding usages functionality implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/folding_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 7. Folding Test
<!-- 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 and running test for folding builder implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/formatter_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 5. Formatter Test
<!-- 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 and running test for the formatter implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/reference_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 10. Reference Test
<!-- 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 and running tests for resolving elements implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/tutorials/writing_tests_for_plugins/rename_test.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# 6. Rename Test
<!-- 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 and running test for rename functionality implemented as a part of the Custom Language Support Tutorial.</link-summary>
<tldr>

4
topics/user_interface_components/notifications.md
View File

@ -1,6 +1,8 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Notifications
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Notifying users about errors, action statuses or other events without interrupting their workflow by showing modal message boxes requiring confirmation.</link-summary>
<tldr>