documentation/test/fixture/optional.output.json

[
  {
    "description": "Represents an IPv6 address",
    "tags": [
      {
        "title": "class",
        "description": null,
        "lineNumber": 2,
        "type": null,
        "name": "Address6"
      },
      {
        "title": "param",
        "description": "An IPv6 address string",
        "lineNumber": 3,
        "type": {
          "type": "NameExpression",
          "name": "string"
        },
        "name": "address"
      },
      {
        "title": "param",
        "description": "How many octets to parse",
        "lineNumber": 4,
        "type": {
          "type": "OptionalType",
          "expression": {
            "type": "NameExpression",
            "name": "number"
          }
        },
        "name": "groups",
        "default": "8"
      },
      {
        "title": "example",
        "description": "var address = new Address6('2001::/32');",
        "lineNumber": 5
      }
    ],
    "loc": {
      "start": {
        "line": 1,
        "column": 0
      },
      "end": {
        "line": 8,
        "column": 3
      }
    },
    "context": {
      "loc": {
        "start": {
          "line": 9,
          "column": 0
        },
        "end": {
          "line": 9,
          "column": 0
        }
      },
      "file": "fixture/optional.input.js"
    },
    "class": {
      "name": "Address6"
    },
    "params": [
      {
        "title": "param",
        "description": "An IPv6 address string",
        "lineNumber": 3,
        "type": {
          "type": "NameExpression",
          "name": "string"
        },
        "name": "address"
      },
      {
        "title": "param",
        "description": "How many octets to parse",
        "lineNumber": 4,
        "type": {
          "type": "OptionalType",
          "expression": {
            "type": "NameExpression",
            "name": "number"
          }
        },
        "name": "groups",
        "default": "8"
      }
    ],
    "examples": [
      "var address = new Address6('2001::/32');"
    ],
    "name": "Address6",
    "kind": "class"
  }
]