Skip to content

Commit

Permalink
some more jsdoc for #15533
Browse files Browse the repository at this point in the history
  • Loading branch information
jrieken committed Jul 19, 2021
1 parent 40a5265 commit 69a8829
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3068,41 +3068,65 @@ declare module 'vscode' {


//#region https://github.com/microsoft/vscode/issues/15533 --- Type hierarchy --- @eskibear

/**
* Represents an item of a type hierarchy, like a class or an interface.
*/
export class TypeHierarchyItem {
/**
* The name of this item.
*/
name: string;

/**
* The kind of this item.
*/
kind: SymbolKind;

/**
* Tags for this item.
*/
tags?: ReadonlyArray<SymbolTag>;

/**
* More detail for this item, e.g. the signature of a function.
*/
detail?: string;

/**
* The resource identifier of this item.
*/
uri: Uri;

/**
* The range enclosing this symbol not including leading/trailing whitespace
* but everything else, e.g. comments and code.
*/
range: Range;

/**
* The range that should be selected and revealed when this symbol is being
* picked, e.g. the name of a class. Must be contained by the {@link TypeHierarchyItem.range range}-property.
*/
selectionRange: Range;

/**
* Creates a new type hierarchy item.
*
* @param kind The kind of the item.
* @param name The name of the item.
* @param detail The details of the item.
* @param uri The Uri of the item.
* @param range The whole range of the item.
* @param selectionRange The selection range of the item.
*/
constructor(kind: SymbolKind, name: string, detail: string, uri: Uri, range: Range, selectionRange: Range);
}

/**
* The type hierarchy provider interface describes the contract between extensions
* and the type hierarchy feature.
*/
export interface TypeHierarchyProvider {

/**
Expand Down

0 comments on commit 69a8829

Please sign in to comment.