[eclipse-lsp4e#254] Extend documentation

travkin79 · Aug 13, 2024 · 9cd8be9 · 9cd8be9
1 parent f40bbf4
commit 9cd8be9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/outline/LSSymbolsContentProvider.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/outline/LSSymbolsContentProvider.java
@@ -7,9 +7,10 @@
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
- *  Mickael Istria (Red Hat Inc.) - initial implementation
- *  Lucas Bullen (Red Hat Inc.) - Bug 508472 - Outline to provide "Link with Editor"
- *                              - Bug 517428 - Requests sent before initialization
+ *  Mickael Istria (Red Hat Inc.)   - initial implementation
+ *  Lucas Bullen (Red Hat Inc.)     - Bug 508472 - Outline to provide "Link with Editor"
+ *                                  - Bug 517428 - Requests sent before initialization
+ *  Dietrich Travkin (Solunar GmbH) - Issue 254  - Add outline view contents filtering
  *******************************************************************************/
 package org.eclipse.lsp4e.outline;
 
@@ -345,7 +346,18 @@ public Object[] getChildren(Object parentElement) {
 			.toArray(Object[]::new);
 	}
 
-	private boolean hideElement(Object element) {
+	/**
+	 * Decide whether to hide the given element or not.
+	 * Default implementation hides elements depending on a preference
+	 * that determines which {@link SymbolKind}s
+	 * (property in {@link DocumentSymbol}, {@link DocumentSymbolWithURI}s, and {@link SymbolInformation})
+	 * are to be hidden in the outline view.
+	 * Sub-classes may override this method to add language-specific filtering.
+	 *
+	 * @param element an outline view contents element to be checked
+	 * @return <code>true</code> if the given element is not to be shown in the outline view
+	 */
+	protected boolean hideElement(Object element) {
 		SymbolKind kind = null;
 
 		if (element instanceof DocumentSymbol) {

diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/outline/OutlineViewFilterMenuContributor.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/outline/OutlineViewFilterMenuContributor.java
@@ -7,7 +7,7 @@
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
- *  Dietrich Travkin (Solunar GmbH) - initial implementation
+ *  Dietrich Travkin (Solunar GmbH) - initial implementation of outline contents filtering (issue #254)
  *******************************************************************************/
 package org.eclipse.lsp4e.outline;