deno_doc 0.198.0

doc generation for deno
Documentation
# mod.ts
/* a non-jsdoc comment */

/**
 * A leading JSDoc comment
 * @module
 */

/** One associated with a class */
export class A {}

# output.txt
A leading JSDoc comment
@module

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

class A
  One associated with a class



# output.json
{
  "module_doc": {
    "doc": "A leading JSDoc comment",
    "tags": [
      {
        "kind": "module"
      }
    ]
  },
  "symbols": [
    {
      "name": "A",
      "declarations": [
        {
          "location": {
            "filename": "file:///mod.ts",
            "line": 8,
            "col": 0,
            "byteIndex": 109
          },
          "declarationKind": "export",
          "jsDoc": {
            "doc": "One associated with a class"
          },
          "kind": "class",
          "def": {}
        }
      ]
    }
  ]
}