naming and doc tweak for #62839

This commit is contained in:
Johannes Rieken 2018-11-16 16:05:58 +01:00
parent 988f7683df
commit 58d5205e5a
3 changed files with 7 additions and 5 deletions

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

@ -2611,12 +2611,14 @@ declare module 'vscode' {
provideDocumentSymbols(document: TextDocument, token: CancellationToken): ProviderResult<SymbolInformation[] | DocumentSymbol[]>;
}
/**
* Metadata about a document symbol provider.
*/
export interface DocumentSymbolProviderMetadata {
/**
* If there is more than one outline provider, this name will be used in the outline tree to
* distinguish between them.
* A human readable string that is shown when multiple outlines trees show for one document.
*/
displayName?: string;
label?: string;
}
/**

View file

@ -278,7 +278,7 @@ export interface ISerializedSignatureHelpProviderMetadata {
export interface MainThreadLanguageFeaturesShape extends IDisposable {
$unregister(handle: number): void;
$registerOutlineSupport(handle: number, selector: ISerializedDocumentFilter[], extensionId: string): void;
$registerOutlineSupport(handle: number, selector: ISerializedDocumentFilter[], label: string): void;
$registerCodeLensSupport(handle: number, selector: ISerializedDocumentFilter[], eventHandle: number): void;
$emitCodeLensEvent(eventHandle: number, event?: any): void;
$registerDefinitionSupport(handle: number, selector: ISerializedDocumentFilter[]): void;

View file

@ -975,7 +975,7 @@ export class ExtHostLanguageFeatures implements ExtHostLanguageFeaturesShape {
registerDocumentSymbolProvider(extension: IExtensionDescription, selector: vscode.DocumentSelector, provider: vscode.DocumentSymbolProvider, metadata?: vscode.DocumentSymbolProviderMetadata): vscode.Disposable {
const handle = this._addNewAdapter(new OutlineAdapter(this._documents, provider), extension);
const displayName = (metadata && metadata.displayName) || (extension && (extension.displayName || extension.name)) || undefined;
const displayName = (metadata && metadata.label) || (extension && (extension.displayName || extension.name)) || undefined;
this._proxy.$registerOutlineSupport(handle, this._transformDocumentSelector(selector), displayName);
return this._createDisposable(handle);
}