JSDoc improvements

alexdima · alexdima · commit 75cf1be16560 · 2020-06-24T13:27:39.000+02:00
diff --git a/src/vs/platform/undoRedo/common/undoRedo.ts b/src/vs/platform/undoRedo/common/undoRedo.ts
@@ -62,8 +62,16 @@ export class ResourceEditStackSnapshot {
 export interface IUndoRedoService {
 	readonly _serviceBrand: undefined;
 
+	/**
+	 * Register an URI -> string hasher.
+	 * This is useful for making multiple URIs share the same undo-redo stack.
+	 */
 	registerUriComparisonKeyComputer(uriComparisonKeyComputer: UriComparisonKeyComputer): IDisposable;
 
+	/**
+	 * Get the hash used internally for a certain URI.
+	 * This uses any registered `UriComparisonKeyComputer`.
+	 */
 	getUriComparisonKey(resource: URI): string;
 
 	/**
@@ -73,22 +81,34 @@ export interface IUndoRedoService {
 	pushElement(element: IUndoRedoElement): void;
 
 	/**
-	 * Get the last pushed element. If the last pushed element has been undone, returns null.
+	 * Get the last pushed element for a resource.
+	 * If the last pushed element has been undone, returns null.
 	 */
 	getLastElement(resource: URI): IUndoRedoElement | null;
 
+	/**
+	 * Get all the elements associated with a resource.
+	 * This includes the past and the future.
+	 */
 	getElements(resource: URI): IPastFutureElements;
 
-	hasElements(resource: URI): boolean;
-
+	/**
+	 * Validate or invalidate stack elements associated with a resource.
+	 */
 	setElementsValidFlag(resource: URI, isValid: boolean, filter: (element: IUndoRedoElement) => boolean): void;
 
 	/**
 	 * Remove elements that target `resource`.
 	 */
 	removeElements(resource: URI): void;
 
+	/**
+	 * Create a snapshot of the current elements on the undo-redo stack for a resource.
+	 */
 	createSnapshot(resource: URI): ResourceEditStackSnapshot;
+	/**
+	 * Attempt (as best as possible) to restore a certain snapshot previously created with `createSnapshot` for a resource.
+	 */
 	restoreSnapshot(snapshot: ResourceEditStackSnapshot): void;
 
 	canUndo(resource: URI): boolean;
