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

# old/mod.ts
/** Adds two numbers */
export function add(a: number, b: number): number { return a + b; }

# new/mod.ts
/**
 * Adds two numbers
 * @example
 * ```ts
 * add(1, 2) // returns 3
 * ```
 */
export function add(a: number, b: number): number { return a + b; }

# output.json
{
  "modifiedModules": {
    "file:///mod.ts": {
      "modified": [
        {
          "name": "add",
          "declarations": {
            "modified": [
              {
                "kind": "function",
                "jsDocChanges": {
                  "tagsChange": {
                    "added": [
                      {
                        "kind": "example",
                        "doc": "```ts\nadd(1, 2) // returns 3\n```"
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      ]
    }
  }
}