documentation/test/fixture/multiexample.output.json

[
  {
    "description": "This function returns the number one.",
    "tags": [
      {
        "title": "returns",
        "description": "numberone",
        "lineNumber": 2,
        "type": {
          "type": "NameExpression",
          "name": "Number"
        }
      },
      {
        "title": "example",
        "description": "foo(1);",
        "lineNumber": 3
      },
      {
        "title": "example",
        "description": "foo(2);",
        "lineNumber": 5
      },
      {
        "title": "throws",
        "description": "if you give it something",
        "lineNumber": 7,
        "type": {
          "type": "NameExpression",
          "name": "Error"
        }
      },
      {
        "title": "throws",
        "description": "if you give it something else",
        "lineNumber": 8,
        "type": {
          "type": "NameExpression",
          "name": "TypeError"
        }
      },
      {
        "title": "augments",
        "description": null,
        "lineNumber": 9,
        "type": null,
        "name": "Foo"
      },
      {
        "title": "augments",
        "description": null,
        "lineNumber": 10,
        "type": null,
        "name": "Bar"
      }
    ],
    "loc": {
      "start": {
        "line": 1,
        "column": 0
      },
      "end": {
        "line": 12,
        "column": 3
      }
    },
    "context": {
      "loc": {
        "start": {
          "line": 13,
          "column": 0
        },
        "end": {
          "line": 16,
          "column": 2
        }
      },
      "file": "fixture/multiexample.input.js",
      "code": "module.exports = function () {\n  // this returns 1\n  return 1;\n};"
    },
    "returns": [
      {
        "title": "returns",
        "description": "numberone",
        "lineNumber": 2,
        "type": {
          "type": "NameExpression",
          "name": "Number"
        }
      }
    ],
    "examples": [
      "foo(1);",
      "foo(2);"
    ],
    "throws": [
      {
        "title": "throws",
        "description": "if you give it something",
        "lineNumber": 7,
        "type": {
          "type": "NameExpression",
          "name": "Error"
        }
      },
      {
        "title": "throws",
        "description": "if you give it something else",
        "lineNumber": 8,
        "type": {
          "type": "NameExpression",
          "name": "TypeError"
        }
      }
    ],
    "augments": [
      {
        "title": "augments",
        "description": null,
        "lineNumber": 9,
        "type": null,
        "name": "Foo"
      },
      {
        "title": "augments",
        "description": null,
        "lineNumber": 10,
        "type": null,
        "name": "Bar"
      }
    ],
    "name": "exports",
    "kind": "function",
    "memberof": "module",
    "scope": "static"
  }
]