deno_doc 0.203.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

# mod.ts
/**
 * A migration registry
 *
 * @example
 * ```ts
 * const migrations = new MigrationRegistry();
 *
 * @migrations.register()
 * class MyMigration {
 *   up() {}
 *   down() {}
 * }
 * ```
 *
 * @param T the type
 */
export class A {}

/**
 * Decorator in doc codeblock
 *
 * ```ts
 * @decorator
 * class Foo {}
 * ```
 */
export class B {}

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

class A
  A migration registry

  @example
      ```ts
      const migrations = new MigrationRegistry();

      @migrations.register()
      class MyMigration {
        up() {}
        down() {}
      }
      ```

  @param T
      the type



Defined in file:///mod.ts:26:1

class B
  Decorator in doc codeblock

  ```ts
  @decorator
  class Foo {}
  ```



# output.json
{
  "symbols": [
    {
      "name": "A",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 16,
            "col": 0,
            "byteIndex": 219
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "A migration registry\n",
            "tags": [
              {
                "kind": "example",
                "doc": "```ts\nconst migrations = new MigrationRegistry();\n\n@migrations.register()\nclass MyMigration {\n  up() {}\n  down() {}\n}\n```\n"
              },
              {
                "kind": "param",
                "name": "T",
                "doc": "the type"
              }
            ]
          },
          "kind": "class",
          "def": {}
        }
      ]
    },
    {
      "name": "B",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 26,
            "col": 0,
            "byteIndex": 325
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "Decorator in doc codeblock\n\n```ts\n@decorator\nclass Foo {}\n```"
          },
          "kind": "class",
          "def": {}
        }
      ]
    }
  ]
}