deno_doc 0.198.0

doc generation for deno
Documentation
# mod.ts
/**
 * Some enum for good measure
 */
export enum Hello {
    World = "world",
    /** There is a JsDoc */
    Fizz = "fizz",
    /** There is a JsDoc
     * @ignore
     */
    Buzz = "buzz",
}
# output.txt
Defined in file:///mod.ts:3:1

enum Hello
  Some enum for good measure

  World
  Fizz
    There is a JsDoc


# output.json
{
  "symbols": [
    {
      "name": "Hello",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 3,
            "col": 0,
            "byteIndex": 38
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "Some enum for good measure"
          },
          "kind": "enum",
          "def": {
            "members": [
              {
                "name": "World",
                "init": {
                  "repr": "world",
                  "kind": "literal",
                  "value": {
                    "kind": "string",
                    "string": "world"
                  }
                },
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 4,
                  "col": 4,
                  "byteIndex": 62
                }
              },
              {
                "name": "Fizz",
                "init": {
                  "repr": "fizz",
                  "kind": "literal",
                  "value": {
                    "kind": "string",
                    "string": "fizz"
                  }
                },
                "jsDoc": {
                  "doc": "There is a JsDoc"
                },
                "location": {
                  "filename": "file:///mod.ts",
                  "line": 6,
                  "col": 4,
                  "byteIndex": 111
                }
              }
            ]
          }
        }
      ]
    }
  ]
}