Skip to content

Commit a19b127

Browse files
travkin79rubenporras
authored andcommitted
Add a developer note to explain an unexpected method parameter
1 parent 5559422 commit a19b127

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

org.eclipse.lsp4e/src/org/eclipse/lsp4e/ui/SymbolIconProvider.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,8 @@ protected String getImageKeyFromSymbolKindWithVisibility(SymbolKind kind, List<S
282282
*/
283283
protected Overlays getOverlaysFor(final SymbolKind symbolKind,
284284
final List<SymbolTag> symbolTags, int severity, Object symbol) {
285+
// The symbol parameter is intentionally added to the method signature in order to give subclasses
286+
// a way to adapt the overlay icons depending on a symbol's properties.
285287

286288
ImageDescriptor severityImageDescriptor = getOverlayForMarkerSeverity(severity);
287289
ImageDescriptor deprecatedImageDescriptor = getUnderlayForDeprecation(SymbolsUtil.isDeprecated(symbolTags));

0 commit comments

Comments
 (0)