More comment fixes, mostly with /* blocks.

Author: sean-mcmanus

Extension/src/Debugger/lldb-dap-worker.ts

@@ -263,7 +263,7 @@ export async function isValidLldbDap(lldbDap: string | undefined) {
 if (!isMainThread) {
     // If this is loaded in a worker thread, we'll set up the remoting interface.
     try {
-        /** This is the SNARE remote call interface dispatcher that the worker thread supports  */
+        /** This is the SNARE remote call interface dispatcher that the worker thread supports. */
         remote = parentPort ? startRemoting(parentPort, {
             // These are the functions that this worker exposes to the parent thread.
             findLldbDapImpl

Extension/src/Utility/Async/manualPromise.ts

@@ -43,14 +43,14 @@ export class ManualPromise<T = void> implements Promise<T> {
      * A method to manually resolve the Promise.
      */
     public resolve: (value?: T | PromiseLike<T> | undefined) => void = (v) => {
-        void v; /* */
+        void v;
     };
 
     /**
      * A method to manually reject the Promise
      */
     public reject: (e: any) => void = (e) => {
-        void e; /* */
+        void e;
     };
 
     private state: 'pending' | 'resolved' | 'rejected' = 'pending';

Extension/src/Utility/Remoting/snare.ts

@@ -70,27 +70,35 @@ export interface RemoteConnection {
     connection: Worker | MessagePort;
 
     /** Terminates the connection and cleans up resources. */
-    terminate(): void; /**
+    terminate(): void;
+
+    /**
      * Makes a request to the remote thread and awaits a response.
      *
      * @param operation The operation name to invoke.
      * @param parameters Parameters to pass to the remote operation.
      * @returns A promise that resolves with the operation result.
      */
-    request(operation: string, ...parameters: any[]): Promise<any>; /**
+    request(operation: string, ...parameters: any[]): Promise<any>;
+
+    /**
      * Sends a notification to the remote thread (fire and forget).
      *
      * @param operation The operation name to invoke.
      * @param parameters Parameters to pass to the remote operation.
      */
-    notify(operation: string, ...parameters: any[]): void; /**
+    notify(operation: string, ...parameters: any[]): void;
+
+    /**
      * Creates a proxy for a remote object.
      *
      * @param ctor Constructor for the proxy type.
      * @param instance Promise of a remote object instance ID.
      * @returns Promise of a proxy to the remote object.
      */
-    marshall<T extends MarshalByReference>(ctor: new (remote: RemoteConnection, instance: number) => T, instance: Promise<number>): Promise<T | undefined>; /**
+    marshall<T extends MarshalByReference>(ctor: new (remote: RemoteConnection, instance: number) => T, instance: Promise<number>): Promise<T | undefined>;
+
+    /**
      * Creates a proxy for a remote object.
      *
      * @param ctor Constructor for the proxy type.
@@ -286,8 +294,8 @@ function sanitize(value: any) {
 /**
  * Sanitizes an array of parameters for remoting.
  *
- * @param parameters Array of parameter values to sanitize
- * @returns Array of sanitized parameters
+ * @param parameters Array of parameter values to sanitize.
+ * @returns Array of sanitized parameters.
  */
 function sanitizeParameters(parameters: any[]) {
     return parameters.map(sanitize);
@@ -414,7 +422,9 @@ export function unref(identity: number) {
  */
 export class MarshalByReference implements Disposable {
     constructor(protected remote: RemoteConnection, protected instance: number) {
-    } /**
+    }
+
+    /**
      * This disposes the ByRef object and notifies the remote thread to reduce the refcount,
      * which would dispose the remote object if it was the last reference.
      */

Extension/src/common-remote-safe.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-/** @file The functions here are safe to call from a worker thread or the main thread.  */
+/** @file The functions here are safe to call from a worker thread or the main thread. */
 
 import { ChildProcess, spawn } from 'node:child_process';
 import { access, constants, readdir, stat } from 'node:fs/promises';
@@ -149,16 +149,12 @@ export interface Disposable {
  *
  * @example
  * item.onDidChange(function(event) { console.log("Event happened: " + event); });
+ *
+ * @param listener The listener function will be called when the event happens.
+ * @param thisArgs The `this`-argument which will be used when calling the event listener.
+ * @param disposables An array to which a {@link Disposable} will be added.
+ * @returns A disposable which unsubscribes the event listener.
  */
-/**
-     * A function that represents an event to which you subscribe by calling it with
-     * a listener function as argument.
-     *
-     * @param listener The listener function will be called when the event happens.
-     * @param thisArgs The `this`-argument which will be used when calling the event listener.
-     * @param disposables An array to which a {@link Disposable} will be added.
-     * @returns A disposable which unsubscribes the event listener.
-     */
 export type Event<T> = (listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]) => Disposable;
 
 /** The key for a localize call.
@@ -296,7 +292,7 @@ interface ProcessOutput {
  * @param continueOn Optional string pattern that, when found in stdout, will cause the process to be considered complete before it exits.
  * @param skipLogging Optional flag to skip logging process output.
  * @param cancellationToken Optional token that can be used to cancel the process.
-  * @returns A promise that resolves to the process output, including stdout, stderr and exit code.
+ * @returns A promise that resolves to the process output, including stdout, stderr and exit code.
  */
 async function spawnChildProcessImpl(program: string, args: string[], continueOn?: string, skipLogging?: boolean, cancellationToken?: CancellationToken): Promise<ProcessOutput> {
     const result = new ManualPromise<ProcessOutput>();
@@ -313,7 +309,9 @@ async function spawnChildProcessImpl(program: string, args: string[], continueOn
         appendLine(localize('killing.process', 'Killing process {0}', program));
 
         proc.kill();
-    }); /** Cleans up resources associated with the process.
+    });
+
+    /** Cleans up resources associated with the process.
      * Removes all event listeners and disposes the cancellation token listener.
      */
     const clean = () => {

Extension/src/links.ts

@@ -3,7 +3,7 @@
  * See 'LICENSE' in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-// Centralized https links that are used by the extension
+// Centralized https links that are used by the extension.
 
 /** Link to documentation on how to troubleshoot LLDB-DAP. */
 export const TroubleshootingLldbDap = "https://aka.ms/vscode-cpptools/TroubleshootingLldbDap";