deno_doc 0.204.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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

# mod.ts
const c = { a: "a", b: 2 };
const d: { f: string; g: number; } = { f: "f", g: 2 };

export const {
  /** export a doc */
  a,
  /** export b doc */
  b,
}: {
  /** type alias doc */
  a: string;
  /** other doc */
  b: number;
} = c;

export const { f, g: h } = d;

# diagnostics
error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> /mod.ts:16:16
   | 
16 | export const { f, g: h } = d;
   |                ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> /mod.ts:16:22
   | 
16 | export const { f, g: h } = d;
   |                      ^

# output.txt
Defined in file:///mod.ts:5:3

const a: string
  export a doc

Defined in file:///mod.ts:7:3

const b: number
  export b doc

Defined in file:///mod.ts:15:16

const f: string

Defined in file:///mod.ts:15:22

const h: number


# output.json
{
  "symbols": [
    {
      "name": "a",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 5,
            "col": 2,
            "byteIndex": 123
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "export a doc"
          },
          "kind": "variable",
          "def": {
            "tsType": {
              "repr": "string",
              "kind": "keyword",
              "value": "string"
            },
            "kind": "const"
          }
        }
      ]
    },
    {
      "name": "b",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 7,
            "col": 2,
            "byteIndex": 150
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "export b doc"
          },
          "kind": "variable",
          "def": {
            "tsType": {
              "repr": "number",
              "kind": "keyword",
              "value": "number"
            },
            "kind": "const"
          }
        }
      ]
    },
    {
      "name": "f",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 15,
            "col": 15,
            "byteIndex": 250
          },
          "declarationKind": "export",
          "kind": "variable",
          "def": {
            "tsType": {
              "repr": "string",
              "kind": "keyword",
              "value": "string"
            },
            "kind": "const"
          }
        }
      ]
    },
    {
      "name": "h",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 15,
            "col": 21,
            "byteIndex": 256
          },
          "declarationKind": "export",
          "kind": "variable",
          "def": {
            "tsType": {
              "repr": "number",
              "kind": "keyword",
              "value": "number"
            },
            "kind": "const"
          }
        }
      ]
    }
  ]
}