SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 22:02:55 +01:00
Code Issues Projects Releases Packages Activity

Include tags in documentation string of suggestion items

Browse source
This commit is contained in:
Sebastian Pahnke 2020-09-07 23:49:30 +02:00
parent a258f3a296
commit 5f2d3f73ab
1 changed files with 20 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/languageFeatures.ts
View file

@ -508,7 +508,7 @@ export class SuggestAdapter
kind: SuggestAdapter.convertKind(details.kind), kind: SuggestAdapter.convertKind(details.kind),
detail: displayPartsToString(details.displayParts), detail: displayPartsToString(details.displayParts),
documentation: { documentation: {
value: displayPartsToString(details.documentation) value: SuggestAdapter.createDocumentationString(details)
} }
}; };
} }
@ -545,6 +545,25 @@ export class SuggestAdapter
return languages.CompletionItemKind.Property; return languages.CompletionItemKind.Property;
} }
private static createDocumentationString(
details: ts.CompletionEntryDetails
): string {
let documentationString = displayPartsToString(details.documentation);
if (details.tags) {
for (const tag of details.tags) {
documentationString += `\n\n*@${tag.name}*`;
if (tag.name === 'param' && tag.text) {
const [paramName, ...rest] = tag.text.split(' ');
documentationString += `\`${paramName}\``;
if (rest.length > 0) documentationString += ` — ${rest.join(' ')}`;
} else if (tag.text) {
documentationString += ` — ${tag.text}`;
}
}
}
return documentationString;
}
} }
export class SignatureHelpAdapter export class SignatureHelpAdapter