deno_doc 0.198.0

doc generation for deno
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# mod.ts
export interface TypedIface<T> {
    something(): T
}

# diagnostics
error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> /mod.ts:1:1
  | 
1 | export interface TypedIface<T> {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> /mod.ts:2:5
  | 
2 |     something(): T
  |     ^

# output.txt
Defined in file:///mod.ts:0:1

interface TypedIface<T>

  something(): T


# output.json
{
  "symbols": [
    {
      "name": "TypedIface",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 0,
            "col": 0,
            "byteIndex": 0
          },
          "declarationKind": "export",
          "kind": "interface",
          "def": {
            "methods": [
              {
                "name": "something",
                "kind": "method",
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 1,
                  "col": 4,
                  "byteIndex": 37
                },
                "params": [],
                "returnType": {
                  "repr": "T",
                  "kind": "typeRef",
                  "value": {
                    "typeName": "T",
                    "resolution": {
                      "kind": "typeParam",
                      "declaringName": "TypedIface",
                      "declaringKind": "interface"
                    }
                  }
                }
              }
            ],
            "typeParams": [
              {
                "name": "T"
              }
            ]
          }
        }
      ]
    }
  ]
}