Skip to content

Commit 5d8be6e

Browse files
travkin79rubenporras
authored andcommitted
Extend extension point documentation
1 parent efa73de commit 5d8be6e

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

org.eclipse.lsp4e/schema/symbolIconsProvider.exsd

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323
<attribute name="point" type="string" use="required">
2424
<annotation>
2525
<documentation>
26-
26+
The fully qualified identifier of the extension point.
27+
28+
This extension point offers client plug-ins options to adapt placement and selection of overlay icons for document symbols and other related elements.
2729
</documentation>
2830
</annotation>
2931
</attribute>
@@ -62,7 +64,7 @@
6264
<attribute name="class" type="string" use="required">
6365
<annotation>
6466
<documentation>
65-
67+
The fully qualified name of the class implementing this symbol icon provider. The class must extend &lt;code&gt;org.eclipse.lsp4e.ui.SymbolIconProvider&lt;/code&gt;. Clients can override individual methods to customize overlay icons and their placement (top-left, top-right, bottom-left, bottom-right, underlay).
6668
</documentation>
6769
<appinfo>
6870
<meta.attribute kind="java" basedOn="org.eclipse.lsp4e.ui.SymbolIconProvider:"/>
@@ -77,7 +79,7 @@
7779
<attribute name="contentTypeId" type="string" use="required">
7880
<annotation>
7981
<documentation>
80-
82+
The unique identifier of a content type (as registered with the &lt;code&gt;org.eclipse.core.contenttype.contentTypes&lt;/code&gt; extension point) for which this icon provider should be used. The provider is also used for all derived content types that do not have a more specific provider registered.
8183
</documentation>
8284
<appinfo>
8385
<meta.attribute kind="identifier" basedOn="org.eclipse.core.contenttype.contentTypes/content-type/@id"/>
@@ -92,7 +94,7 @@
9294
<meta.section type="since"/>
9395
</appinfo>
9496
<documentation>
95-
[Enter the first release in which this extension point appears.]
97+
0.19.10
9698
</documentation>
9799
</annotation>
98100

@@ -119,7 +121,7 @@
119121
<meta.section type="implementation"/>
120122
</appinfo>
121123
<documentation>
122-
[Enter information about supplied implementation of this extension point.]
124+
LSP4E provides a default implementation via &lt;code&gt;org.eclipse.lsp4e.ui.SymbolIconProvider&lt;/code&gt;. It is used automatically for all content types that have no specific provider registered through this extension point. It renders symbol icons based on the LSP &lt;code&gt;SymbolKind&lt;/code&gt; and up to four overlay icons derived from &lt;code&gt;SymbolTag&lt;/code&gt;s (visibility, static/final/abstract/etc., marker severity) plus a deprecation underlay.
123125
</documentation>
124126
</annotation>
125127

0 commit comments

Comments
 (0)