Properly extract XML doc comment summary content in hover tips, signature help, and completion list

Author: DustinCampbell

src/features/completionItemProvider.ts

@@ -5,7 +5,7 @@
 
 'use strict';
 
-import {plain} from './documentation';
+import {extractSummaryText} from './documentation';
 import AbstractSupport from './abstractProvider';
 import * as protocol from '../protocol';
 import * as serverUtils from '../omnisharpUtils';
@@ -42,13 +42,14 @@ export default class OmniSharpCompletionItemProvider extends AbstractSupport imp
 			for (let value of values) {
 				let completion = new CompletionItem(value.CompletionText.replace(/\(|\)|<|>/g, ''));
 				completion.detail = value.ReturnType ? `${value.ReturnType} ${value.DisplayText}` : value.DisplayText;
-				completion.documentation = plain(value.Description);
+				completion.documentation = extractSummaryText(value.Description);
 				completion.kind = _kinds[value.Kind] || CompletionItemKind.Property;
 
 				let array = completions[completion.label];
 				if (!array) {
 					completions[completion.label] = [completion];
-				} else {
+				}
+				else {
 					array.push(completion);
 				}
 			}
@@ -63,10 +64,12 @@ export default class OmniSharpCompletionItemProvider extends AbstractSupport imp
 					// remove non overloaded items
 					delete completions[key];
 
-				} else {
+				}
+				else {
 					// indicate that there is more
 					suggestion.detail = `${suggestion.detail} (+ ${overloadCount} overload(s))`;
 				}
+				
 				result.push(suggestion);
 			}
 

src/features/documentation.ts

@@ -2,29 +2,30 @@
  *  Copyright (c) Microsoft Corporation. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-'use strict';
-
 
-const _regExp = /<(\S*?).*?>((.|\r|\n)*?)<\/\1>/;
+'use strict';
 
-/**
- * remove xml-tags from string
- */
-export function plain(doc: string): string {
+const summaryStartTag = /<summary>/i;
+const summaryEndTag = /<\/summary>/i;
 
-	if (!doc) {
-		return doc;
+export function extractSummaryText(xmlDocComment: string): string {
+	if (!xmlDocComment) {
+		return xmlDocComment;
 	}
-
-	let newDoc: string;
-
-	while (true) {
-		newDoc = doc.replace(_regExp,(m, g1, g2, g3) => g2);
-		if (newDoc === doc) {
-			break;
-		}
-		doc = newDoc;
+	
+	let summary = xmlDocComment;
+	
+	let startIndex = summary.search(summaryStartTag);
+	if (startIndex < 0) {
+		return summary;
 	}
-
-	return newDoc;
+	
+	summary = summary.slice(startIndex + '<summary>'.length);
+	
+	let endIndex = summary.search(summaryEndTag);
+	if (endIndex < 0) {
+		return summary;
+	}
+	
+	return summary.slice(0, endIndex);
 }

src/features/hoverProvider.ts

@@ -5,7 +5,7 @@
 
 'use strict';
 
-import {plain} from './documentation';
+import {extractSummaryText} from './documentation';
 import AbstractSupport from './abstractProvider';
 import * as protocol from '../protocol';
 import * as serverUtils from '../omnisharpUtils';
@@ -21,7 +21,7 @@ export default class OmniSharpHoverProvider extends AbstractSupport implements H
 
 		return serverUtils.typeLookup(this._server, req, token).then(value => {
 			if (value && value.Type) {
-				let contents = [plain(value.Documentation), { language: 'csharp', value: value.Type }];
+				let contents = [extractSummaryText(value.Documentation), { language: 'csharp', value: value.Type }];
 				return new Hover(contents);
 			}
 		});

src/features/signatureHelpProvider.ts

@@ -7,6 +7,7 @@
 
 import AbstractSupport from './abstractProvider';
 import * as serverUtils from '../omnisharpUtils';
+import {extractSummaryText} from './documentation';
 import {createRequest} from '../typeConvertion';
 import {SignatureHelpProvider, SignatureHelp, SignatureInformation, ParameterInformation, CancellationToken, TextDocument, Position} from 'vscode';
 
@@ -26,15 +27,15 @@ export default class OmniSharpSignatureHelpProvider extends AbstractSupport impl
 			ret.activeSignature = res.ActiveSignature;
 			ret.activeParameter = res.ActiveParameter;
 
-			for(let signature of res.Signatures) {
+			for (let signature of res.Signatures) {
 
-				let signatureInfo = new SignatureInformation(signature.Label, signature.Documentation);
+				let signatureInfo = new SignatureInformation(signature.Label, extractSummaryText(signature.Documentation));
 				ret.signatures.push(signatureInfo);
 
 				for (let parameter of signature.Parameters) {
 					let parameterInfo = new ParameterInformation(
 						parameter.Label,
-						parameter.Documentation);
+						extractSummaryText(parameter.Documentation));
 
 					signatureInfo.parameters.push(parameterInfo);
 				}