idea-plugin / arrow.meta.ide.dsl.editor.documentation / DocumentationSyntax

DocumentationSyntax

interface DocumentationSyntax

DocumentationSyntax registers an extension for documentation support. Check out Documentation

Functions

addDocumentationProvider registers a DocumentationProvider. Users are now able to hover over descriptors and see the provided documentation.open fun IdeMetaPlugin.addDocumentationProvider(quickNavigateInfo: (element: PsiElement, originalElement: PsiElement) -> String? = Noop.nullable2(), generateDoc: (element: PsiElement, originalElement: PsiElement) -> String? = Noop.nullable2(), documentationElementForLink: (psiManager: PsiManager, link: String, context: PsiElement) -> PsiElement? = Noop.nullable3()): ExtensionPhase
quickDocumentationProvider An example is here {@link https://github.com/JetBrains/kotlin/blob/49d6bbbd6b1c2fea85df03af047aa0cf21ce0b97/idea/src/org/jetbrains/kotlin/idea/KotlinQuickDocumentationProvider.kt#L148}open fun DocumentationSyntax.quickDocumentationProvider(quickNavigateInfo: (element: PsiElement, originalElement: PsiElement) -> String?, generateDoc: (element: PsiElement, originalElement: PsiElement) -> String?, documentationElementForLink: (psiManager: PsiManager, link: String, context: PsiElement) -> PsiElement?): AbstractDocumentationProvider

Inheritors

IdeSyntax interface IdeSyntax : IconProviderSyntax, SyntaxHighlighterSyntax, InspectionSyntax, AnActionSyntax, ColorSettingsSyntax, HintingSyntax, LanguageSyntax, LineMarkerSyntax, LiveTemplateSyntax, NavigationSyntax, SearchSyntax, StructureViewSyntax, UsageSyntax, ExtensionProviderSyntax, DocumentationSyntax, KotlinExtensionSyntax, DialogSyntax, PopupSyntax, NotificationSyntax, ToolWindowSyntax, GotoRelatedSyntax, AnnotatorSyntax, ParserSyntax, ApplicationSyntax, FoldingSyntax, EditorSyntax, ResolveScopeSyntax, ResolveProviderSyntax

Do you like Arrow?

Arrow Org
<