add jsdoc comment for trackFocus (microsoft#180690)

jrieken · web-flow · commit f0a3f5f66d09 · 2023-04-24T15:25:47.000+02:00
diff --git a/src/vs/base/browser/dom.ts b/src/vs/base/browser/dom.ts
@@ -930,6 +930,12 @@ class FocusTracker extends Disposable implements IFocusTracker {
 	}
 }
 
+/**
+ * Creates a new `IFocusTracker` instance that tracks focus changes on the given `element` and its descendants.
+ *
+ * @param element The `HTMLElement` or `Window` to track focus changes on.
+ * @returns An `IFocusTracker` instance.
+ */
 export function trackFocus(element: HTMLElement | Window): IFocusTracker {
 	return new FocusTracker(element);
 }

Original file line number	Diff line number	Diff line change
`@@ -930,6 +930,12 @@ class FocusTracker extends Disposable implements IFocusTracker {`
`930`	`930`	`}`
`931`	`931`	`}`
`932`	`932`
	`933`	`+/**`
	`934`	+ * Creates a new `IFocusTracker` instance that tracks focus changes on the given `element` and its descendants.
	`935`	`+ *`
	`936`	+ * @param element The `HTMLElement` or `Window` to track focus changes on.
	`937`	+ * @returns An `IFocusTracker` instance.
	`938`	`+ */`
`933`	`939`	`export function trackFocus(element: HTMLElement \| Window): IFocusTracker {`
`934`	`940`	`return new FocusTracker(element);`
`935`	`941`	`}`