MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-01-04 17:20:55 +07:00
Code Issues Packages Projects Releases Wiki Activity

[yaml] IJ-CR-147338 Add documentation to the recently introduced extension point

Browse Source 
(cherry picked from commit e524f4c59adab9ef6877df039d53ad57cd5cc2a8)

GitOrigin-RevId: debd6e9731ef923e285554bb44a42036d954752e
This commit is contained in:
Nikita Katkov
2024-10-22 16:31:10 +02:00
committed by intellij-monorepo-bot
parent d7d0a2dd4b
commit a1b3324aa9
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
plugins/yaml/editing/src/org/jetbrains/yaml/psi/YamlTagRecogniser.kt
View File

@@ -2,12 +2,23 @@ package org.jetbrains.yaml.psi
import com.intellij.openapi.extensions.ExtensionPointName import com.intellij.openapi.extensions.ExtensionPointName
import com.intellij.openapi.util.NlsSafe import com.intellij.openapi.util.NlsSafe
import org.jetbrains.annotations.ApiStatus
/**
* Interface for recognising known domain-specific YAML tags.
*
* This interface allows implementations to inform the IDE about YAML tags that are expected in a particular YAML-based framework.
* If a tag is recognised by any implementation, no warnings will be reported in the editor.
*/
@ApiStatus.Experimental
interface YamlTagRecogniser { interface YamlTagRecogniser {
companion object { companion object {
@JvmField @JvmField
val EP_NAME = ExtensionPointName.create<YamlTagRecogniser>("com.intellij.yaml.tagRecogniser") val EP_NAME = ExtensionPointName.create<YamlTagRecogniser>("com.intellij.yaml.tagRecogniser")
} }
/**
* Checks if the provided tag text is recognised as a known domain-specific YAML tag.
*/
fun isRecognizedTag(tagText: @NlsSafe String): Boolean fun isRecognizedTag(tagText: @NlsSafe String): Boolean
} }