Using Structured Documentation for Signature Help and improving Parameter Documentation

src/features/signatureHelpProvider.ts

@@ -7,9 +7,10 @@
 
 import AbstractSupport from './abstractProvider';
 import * as serverUtils from '../omnisharp/utils';
-import {extractSummaryText} from './documentation';
-import {createRequest} from '../omnisharp/typeConvertion';
-import {SignatureHelpProvider, SignatureHelp, SignatureInformation, ParameterInformation, CancellationToken, TextDocument, Position} from 'vscode';
+import { createRequest } from '../omnisharp/typeConvertion';
+import { SignatureHelpProvider, SignatureHelp, SignatureInformation, ParameterInformation, CancellationToken, TextDocument, Position } from 'vscode';
+import { MarkdownString } from 'vscode';
+import { SignatureHelpParameter } from '../omnisharp/protocol';
 
 export default class OmniSharpSignatureHelpProvider extends AbstractSupport implements SignatureHelpProvider {
 
@@ -18,7 +19,7 @@ export default class OmniSharpSignatureHelpProvider extends AbstractSupport impl
         let req = createRequest(document, position);
 
         return serverUtils.signatureHelp(this._server, req, token).then(res => {
-            
+
             if (!res) {
                 return undefined;
             }
@@ -29,13 +30,13 @@ export default class OmniSharpSignatureHelpProvider extends AbstractSupport impl
 
             for (let signature of res.Signatures) {
 
-                let signatureInfo = new SignatureInformation(signature.Label, extractSummaryText(signature.Documentation));
+                let signatureInfo = new SignatureInformation(signature.Label, signature.StructuredDocumentation.SummaryText);
                 ret.signatures.push(signatureInfo);
 
                 for (let parameter of signature.Parameters) {
                     let parameterInfo = new ParameterInformation(
                         parameter.Label,
-                        extractSummaryText(parameter.Documentation));
+                        this.GetParameterDocumentation(parameter));
 
                     signatureInfo.parameters.push(parameterInfo);
                 }
@@ -44,4 +45,14 @@ export default class OmniSharpSignatureHelpProvider extends AbstractSupport impl
             return ret;
         });
     }
+
+    private GetParameterDocumentation(parameter: SignatureHelpParameter) {
+        let summary = parameter.Documentation;
+        if (summary.length > 0) {
+            let nameInBold = "**" + parameter.Name + "**" + ": ";
+            return new MarkdownString(nameInBold + summary);
+        }
+
+        return "";
+    }
 }

src/omnisharp/protocol.ts

@@ -214,6 +214,22 @@ export interface FindSymbolsResponse {
     QuickFixes: SymbolLocation[];
 }
 
+export interface DocumentationItem {
+    Name: string;
+    Documentation: string;
+}
+
+export interface DocumentationComment {
+    SummaryText: string ;
+    TypeParamElements :DocumentationItem[];
+    ParamElements :  DocumentationItem[];
+    ReturnsText : string ;
+    RemarksText : string;
+    ExampleText : string;
+    ValueText: string;
+    Exception : DocumentationItem[];
+}
+
 export interface TypeLookupRequest extends Request {
     IncludeDocumentation: boolean;
 }
@@ -373,6 +389,7 @@ export interface SignatureHelpItem {
     Label: string;
     Documentation: string;
     Parameters: SignatureHelpParameter[];
+    StructuredDocumentation: DocumentationComment;
 }
 
 export interface SignatureHelpParameter {