File: jsDocFunctionSignatures6.ts

package info (click to toggle)
node-typescript 4.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 396,552 kB
  • sloc: javascript: 1,444,377; makefile: 7; sh: 3
file content (24 lines) | stat: -rw-r--r-- 1,043 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
///<reference path="fourslash.ts" />
// @allowJs: true
// @Filename: Foo.js
/////**
//// * @param {string} p1 - A string param
//// * @param {string?} p2 - An optional param
//// * @param {string} [p3] - Another optional param
//// * @param {string} [p4="test"] - An optional param with a default value
//// */
////function f1(p1, p2, p3, p4){}
////f1(/*1*/'foo', /*2*/'bar', /*3*/'baz', /*4*/'qux');

const tags: ReadonlyArray<FourSlashInterface.JSDocTagInfo> = [
    { name: "param", text: "p1 - A string param" },
    { name: "param", text: "p2 - An optional param" },
    { name: "param", text: "p3 - Another optional param" },
    { name: "param", text: "p4 - An optional param with a default value" },
];
verify.signatureHelp(
    { marker: "1", parameterDocComment: "- A string param", tags },
    { marker: "2", parameterDocComment: "- An optional param", tags },
    { marker: "3", parameterDocComment: "- Another optional param", tags },
    { marker: "4", parameterDocComment: "- An optional param with a default value", tags },
);