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

Don't use * in links

Browse Source
This commit is contained in:
Karol Lewandowski 2025-01-10 10:41:05 +01:00
parent 5a10a92983
commit 57b05e01b4
3 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/scripts/generate_descriptor_pages.main.kts vendored
View File

@ -391,6 +391,7 @@ fun file(path: String): File {
fun String.cleanup(): String { fun String.cleanup(): String {
return this return this
.cleanupElementLinks() .cleanupElementLinks()
.fixWildcardLinks()
.removeAttributeLinks() .removeAttributeLinks()
.removeDocProviderSpecificAttributes() .removeDocProviderSpecificAttributes()
.internalizeLinks() .internalizeLinks()
@ -401,6 +402,12 @@ fun String.cleanupElementLinks(): String {
return replace("](#element:", "](#") return replace("](#element:", "](#")
} }
fun String.fixWildcardLinks(): String {
// reason: Writerside can't handle links with * and the error page is displayed
// [wildcard](path__to__*) -> [wildcard](#path__to__-)
return replace("__*", "__-")
}
fun String.removeAttributeLinks(): String { fun String.removeAttributeLinks(): String {
val attributeLinkRegex = Regex("\\[([^\\[\\]]*?)]\\(#attribute:.*?\\)") val attributeLinkRegex = Regex("\\[([^\\[\\]]*?)]\\(#attribute:.*?\\)")
return attributeLinkRegex.replace(this) { matchResult -> return attributeLinkRegex.replace(this) { matchResult ->

4
topics/basics/plugin_structure/plugin_configuration_file.md
View File

@ -52,7 +52,7 @@ Deprecated elements are omitted in the list below.
- [`<depends>`](#idea-plugin__depends) - [`<depends>`](#idea-plugin__depends)
- [`<incompatible-with>`](#idea-plugin__incompatible-with) - [`<incompatible-with>`](#idea-plugin__incompatible-with)
- [`<extensions>`](#idea-plugin__extensions) - [`<extensions>`](#idea-plugin__extensions)
- [An Extension](#idea-plugin__extensions__*) - [An Extension](#idea-plugin__extensions__-)
- [`<extensionPoints>`](#idea-plugin__extensionPoints) - [`<extensionPoints>`](#idea-plugin__extensionPoints)
- [`<extensionPoint>`](#idea-plugin__extensionPoints__extensionPoint) - [`<extensionPoint>`](#idea-plugin__extensionPoints__extensionPoint)
- [`<with>`](#idea-plugin__extensionPoints__extensionPoint__with) - [`<with>`](#idea-plugin__extensionPoints__extensionPoint__with)
@ -568,7 +568,7 @@ Examples
``` ```
#### An Extension #### An Extension
{#idea-plugin__extensions__*} {#idea-plugin__extensions__-}
An extension instance registered under [`<extensions>`](#idea-plugin__extensions). An extension instance registered under [`<extensions>`](#idea-plugin__extensions).

2
topics/basics/plugin_structure/plugin_extensions.md
View File

@ -41,7 +41,7 @@ See [](explore_api.md) for more information and strategies.
* If the extension point was declared using the `beanClass` attribute, set all properties annotated with the [`@Attribute`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/annotations/Attribute.java) and [`Tag`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/annotations/Tag.java) annotations in the specified bean class. * If the extension point was declared using the `beanClass` attribute, set all properties annotated with the [`@Attribute`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/annotations/Attribute.java) and [`Tag`](%gh-ic%/platform/util/src/com/intellij/util/xmlb/annotations/Tag.java) annotations in the specified bean class.
See the [](plugin_extension_points.md#declaring-extension-points) section for details. See the [](plugin_extension_points.md#declaring-extension-points) section for details.
4. In addition to attributes defined by the extension point, the extension element can specify basic attributes (see the attributes list in [](plugin_configuration_file.md#idea-plugin__extensions__*) section). 4. In addition to attributes defined by the extension point, the extension element can specify basic attributes (see the attributes list in [](plugin_configuration_file.md#idea-plugin__extensions__-) section).
5. Implement the extension API as required (see [](#implementing-extension)). 5. Implement the extension API as required (see [](#implementing-extension)).
</procedure> </procedure>