Clean up checks and add documentation

Author: travkin79

bundles/org.eclipse.cdt.lsp/src/org/eclipse/cdt/lsp/services/ClangdLanguageServer.java

@@ -33,7 +33,7 @@
 public interface ClangdLanguageServer extends LanguageServer {
 
 	/**
-	 * The switchSourceHeader request is sent from the client to the server to
+	 * The <em>textDocument/switchSourceHeader</em> request is sent from the client to the server to
 	 * <ul>
 	 * <li>get the corresponding header if a source file was provided</li>
 	 * <li>get the source file if a header was provided</li>
@@ -47,9 +47,30 @@ public interface ClangdLanguageServer extends LanguageServer {
 	@JsonRequest(value = "textDocument/switchSourceHeader")
 	CompletableFuture<String> switchSourceHeader(TextDocumentIdentifier textDocument);
 
+	/**
+	 * The <em>textDocument/ast</em> request is sent from the client to the server in order to get
+	 * details about the program structure (so called abstract syntax tree or AST) in a C++ file.
+	 * The structure can be requested for the whole file or for a certain range.
+	 *
+	 * @param astParameters request parameters containing the document identifier and requested documented range
+	 * @return the abstract syntax tree root node (with child hierarchy) for the requested document and range
+	 *
+	 * @see https://clangd.llvm.org/extensions#ast
+	 */
 	@JsonRequest(value = "textDocument/ast")
 	CompletableFuture<AstNode> getAst(AstParams astParameters);
 
+	/**
+	 * The <em>textDocument/symbolInfo</em> request is sent from the client to the server in order to access
+	 * details about the element under the cursor. The response provides details like the element's name,
+	 * its parent container's name, and some clangd-specific element IDs (e.g. the "unified symbol resolution"
+	 * identifier).
+	 *
+	 * @param positionParameters request parameters containing the document identifier and the current cursor position
+	 * @return the details about the symbol on the given position
+	 *
+	 * @see https://clangd.llvm.org/extensions#symbol-info-request
+	 */
 	@JsonRequest(value = "textDocument/symbolInfo")
 	CompletableFuture<SymbolDetails[]> getSymbolInfo(TextDocumentPositionParams positionParameters);
 }

bundles/org.eclipse.cdt.lsp/src/org/eclipse/cdt/lsp/services/ast/AstNode.java

@@ -2,11 +2,20 @@
 
 import java.util.Arrays;
 
+import org.eclipse.cdt.lsp.services.ClangdLanguageServer;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
 import org.eclipse.lsp4j.util.Preconditions;
 import org.eclipse.lsp4j.util.ToStringBuilder;
 
+/**
+ * Return type for the <em>textDocument/ast</em> request.
+ * This class was generated by the <em>org.eclipse.lsp4j.generator</em> bundle
+ * using xtend (see {@link org.eclipse.lsp4j.generator.JsonRpcData JsonRpcData} and
+ * the <a href="https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md">documentation</a>).
+ *
+ * @see {@link ClangdLanguageServer#getAst(AstParams)}
+ */
 public class AstNode {
 
 	@NonNull

bundles/org.eclipse.cdt.lsp/src/org/eclipse/cdt/lsp/services/ast/AstParams.java

@@ -1,11 +1,20 @@
 package org.eclipse.cdt.lsp.services.ast;
 
+import org.eclipse.cdt.lsp.services.ClangdLanguageServer;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.TextDocumentIdentifier;
 import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
 import org.eclipse.lsp4j.util.Preconditions;
 import org.eclipse.lsp4j.util.ToStringBuilder;
 
+/**
+ * Parameter object type for the <em>textDocument/ast</em> request.
+ * This class was generated by the <em>org.eclipse.lsp4j.generator</em> bundle
+ * using xtend (see {@link org.eclipse.lsp4j.generator.JsonRpcData JsonRpcData} and
+ * the <a href="https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md">documentation</a>).
+ *
+ * @see {@link ClangdLanguageServer#getAst(AstParams)}
+ */
 public class AstParams {
 
 	@NonNull

bundles/org.eclipse.cdt.lsp/src/org/eclipse/cdt/lsp/services/symbolinfo/RangeAndUri.java

@@ -1,11 +1,20 @@
 package org.eclipse.cdt.lsp.services.symbolinfo;
 
+import org.eclipse.cdt.lsp.services.ClangdLanguageServer;
 import org.eclipse.lsp4j.Range;
 import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
 import org.eclipse.lsp4j.util.Preconditions;
 import org.eclipse.lsp4j.util.ToStringBuilder;
 
-@SuppressWarnings("all")
+/**
+ * Data type used in {@link SymbolDetails} for the <em>textDocument/symbolInfo</em> request.
+ * This class was generated by the <em>org.eclipse.lsp4j.generator</em> bundle
+ * using xtend (see {@link org.eclipse.lsp4j.generator.JsonRpcData JsonRpcData} and
+ * the <a href="https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md">documentation</a>).
+ *
+ * @see {@link SymbolDetails}
+ * @see {@link ClangdLanguageServer#getSymbolInfo(org.eclipse.lsp4j.TextDocumentPositionParams)}
+ */
 public class RangeAndUri {
 	@NonNull
 	private Range range;
@@ -19,7 +28,7 @@ public Range getRange() {
 	}
 
 	public void setRange(@NonNull final Range range) {
-		this.range = Preconditions.checkNotNull(range, "range");
+		this.range = Preconditions.<Range>checkNotNull(range, "range"); //$NON-NLS-1$
 	}
 
 	@NonNull
@@ -28,14 +37,14 @@ public String getUri() {
 	}
 
 	public void setUri(@NonNull final String uri) {
-		this.uri = Preconditions.checkNotNull(uri, "uri");
+		this.uri = Preconditions.<String>checkNotNull(uri, "uri"); //$NON-NLS-1$
 	}
 
 	@Override
 	public String toString() {
 		ToStringBuilder b = new ToStringBuilder(this);
-		b.add("range", this.range);
-		b.add("uri", this.uri);
+		b.add("range", this.range); //$NON-NLS-1$
+		b.add("uri", this.uri); //$NON-NLS-1$
 		return b.toString();
 	}
 

bundles/org.eclipse.cdt.lsp/src/org/eclipse/cdt/lsp/services/symbolinfo/SymbolDetails.java

@@ -1,10 +1,20 @@
 package org.eclipse.cdt.lsp.services.symbolinfo;
 
+import org.eclipse.cdt.lsp.services.ClangdLanguageServer;
 import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
 import org.eclipse.lsp4j.util.Preconditions;
 import org.eclipse.lsp4j.util.ToStringBuilder;
 
+/**
+ * Return type for the <em>textDocument/symbolInfo</em> request.
+ * This class was generated by the <em>org.eclipse.lsp4j.generator</em> bundle
+ * using xtend (see {@link org.eclipse.lsp4j.generator.JsonRpcData JsonRpcData} and
+ * the <a href="https://github.com/eclipse-lsp4j/lsp4j/blob/main/documentation/jsonrpc.md">documentation</a>).
+ *
+ * @see {@link ClangdLanguageServer#getSymbolInfo(org.eclipse.lsp4j.TextDocumentPositionParams)}
+ */
 public class SymbolDetails {
+
 	@NonNull
 	private String name;