Small comment cleanup

This commit is contained in:
Matt Bierner 2021-07-26 15:50:58 -07:00
parent d9e316e1f6
commit bee5add76a
No known key found for this signature in database
GPG key ID: 099C331567E11888

42
src/vs/vscode.d.ts vendored
View file

@ -14166,7 +14166,7 @@ declare module 'vscode' {
add(item: TestItem): void; add(item: TestItem): void;
/** /**
* Removes the a single test item from the collection. * Removes a single test item from the collection.
* @param itemId Item ID to delete. * @param itemId Item ID to delete.
*/ */
delete(itemId: string): void; delete(itemId: string): void;
@ -14174,32 +14174,34 @@ declare module 'vscode' {
/** /**
* Efficiently gets a test item by ID, if it exists, in the children. * Efficiently gets a test item by ID, if it exists, in the children.
* @param itemId Item ID to get. * @param itemId Item ID to get.
* @returns The found item, or undefined if it does not exist. * @returns The found item or undefined if it does not exist.
*/ */
get(itemId: string): TestItem | undefined; get(itemId: string): TestItem | undefined;
} }
/** /**
* A test item is an item shown in the "test explorer" view. It encompasses * An item shown in the "test explorer" view.
* both a suite and a test, since they simiular capabilities. *
* A `TestItem` can represent either a test suite or a test itself, since
* they both have similar capabilities.
*/ */
export interface TestItem { export interface TestItem {
/** /**
* Identifier for the TestItem. This is used to correlate * Identifier for the `TestItem`. This is used to correlate
* test results and tests in the document with those in the workspace * test results and tests in the document with those in the workspace
* (test explorer). This cannot change for the lifetime of the TestItem, * (test explorer). This cannot change for the lifetime of the `TestItem`,
* and must be unique among its parent's direct children. * and must be unique among its parent's direct children.
*/ */
readonly id: string; readonly id: string;
/** /**
* URI this TestItem is associated with. May be a file or directory. * URI this `TestItem` is associated with. May be a file or directory.
*/ */
readonly uri?: Uri; readonly uri?: Uri;
/** /**
* The children of this test item. For a test suite, this may contain the * The children of this test item. For a test suite, this may contain the
* individual test cases, or nested suites. * individual test cases or nested suites.
*/ */
readonly children: TestItemCollection; readonly children: TestItemCollection;
@ -14212,7 +14214,8 @@ declare module 'vscode' {
/** /**
* Indicates whether this test item may have children discovered by resolving. * Indicates whether this test item may have children discovered by resolving.
* If so, it will be shown as expandable in the Test Explorer view, and *
* If true, this item is shown as expandable in the Test Explorer view and
* expanding the item will cause {@link TestController.resolveHandler} * expanding the item will cause {@link TestController.resolveHandler}
* to be invoked with the item. * to be invoked with the item.
* *
@ -14222,8 +14225,9 @@ declare module 'vscode' {
/** /**
* Controls whether the item is shown as "busy" in the Test Explorer view. * Controls whether the item is shown as "busy" in the Test Explorer view.
* This is useful for showing status while discovering children. Defaults * This is useful for showing status while discovering children.
* to false. *
* Defaults to `false`.
*/ */
busy: boolean; busy: boolean;
@ -14238,15 +14242,17 @@ declare module 'vscode' {
description?: string; description?: string;
/** /**
* Location of the test item in its `uri`. This is only meaningful if the * Location of the test item in its {@link uri}.
* `uri` points to a file. *
* This is only meaningful if the `uri` points to a file.
*/ */
range?: Range; range?: Range;
/** /**
* May be set to an error associated with loading the test. Note that this * Optional error encountered while loading the test.
* is not a test result and should only be used to represent errors in *
* discovery, such as syntax errors. * Note that this is not a test result and should only be used to represent errors in
* test discovery, such as syntax errors.
*/ */
error?: string | MarkdownString; error?: string | MarkdownString;
} }
@ -14262,12 +14268,12 @@ declare module 'vscode' {
message: string | MarkdownString; message: string | MarkdownString;
/** /**
* Expected test output. If given with `actualOutput`, a diff view will be shown. * Expected test output. If given with {@link actualOutput}, a diff view will be shown.
*/ */
expectedOutput?: string; expectedOutput?: string;
/** /**
* Actual test output. If given with `expectedOutput`, a diff view will be shown. * Actual test output. If given with {@link expectedOutput}, a diff view will be shown.
*/ */
actualOutput?: string; actualOutput?: string;