documentation-polyglot/__tests__/fixture/blend.json

C++ plugin for documentation.js

[
  {
    "description": {
      "type": "root",
      "children": [
        {
          "type": "paragraph",
          "children": [
            {
              "type": "text",
              "value": "This method moves a hex to a color",
              "position": {
                "start": {
                  "line": 1,
                  "column": 1,
                  "offset": 0
                },
                "end": {
                  "line": 1,
                  "column": 35,
                  "offset": 34
                },
                "indent": []
              }
            }
          ],
          "position": {
            "start": {
              "line": 1,
              "column": 1,
              "offset": 0
            },
            "end": {
              "line": 1,
              "column": 35,
              "offset": 34
            },
            "indent": []
          }
        }
      ],
      "position": {
        "start": {
          "line": 1,
          "column": 1,
          "offset": 0
        },
        "end": {
          "line": 1,
          "column": 35,
          "offset": 34
        }
      }
    },
    "tags": [
      {
        "title": "name",
        "description": null,
        "lineNumber": 2,
        "name": "hexToUInt32Color"
      },
      {
        "title": "param",
        "description": null,
        "lineNumber": 3,
        "type": {
          "type": "NameExpression",
          "name": "string"
        },
        "name": "hex"
      },
      {
        "title": "returns",
        "description": "color",
        "lineNumber": 4,
        "type": {
          "type": "NameExpression",
          "name": "number"
        }
      }
    ],
    "loc": {
      "start": {
        "line": 35,
        "column": 1
      },
      "end": {
        "line": 40,
        "column": 3
      }
    },
    "context": {
      "loc": {
        "start": {
          "line": 35,
          "column": 1
        },
        "end": {
          "line": 40,
          "column": 3
        }
      },
      "file": "[path]"
    },
    "augments": [],
    "examples": [],
    "params": [
      {
        "title": "param",
        "name": "hex",
        "lineNumber": 3,
        "type": {
          "type": "NameExpression",
          "name": "string"
        }
      }
    ],
    "properties": [],
    "returns": [
      {
        "description": {
          "type": "root",
          "children": [
            {
              "type": "paragraph",
              "children": [
                {
                  "type": "text",
                  "value": "color",
                  "position": {
                    "start": {
                      "line": 1,
                      "column": 1,
                      "offset": 0
                    },
                    "end": {
                      "line": 1,
                      "column": 6,
                      "offset": 5
                    },
                    "indent": []
                  }
                }
              ],
              "position": {
                "start": {
                  "line": 1,
                  "column": 1,
                  "offset": 0
                },
                "end": {
                  "line": 1,
                  "column": 6,
                  "offset": 5
                },
                "indent": []
              }
            }
          ],
          "position": {
            "start": {
              "line": 1,
              "column": 1,
              "offset": 0
            },
            "end": {
              "line": 1,
              "column": 6,
              "offset": 5
            }
          }
        },
        "title": "returns",
        "type": {
          "type": "NameExpression",
          "name": "number"
        }
      }
    ],
    "sees": [],
    "throws": [],
    "todos": [],
    "name": "hexToUInt32Color",
    "members": {
      "global": [],
      "inner": [],
      "instance": [],
      "events": [],
      "static": []
    },
    "path": [
      {
        "name": "hexToUInt32Color"
      }
    ],
    "namespace": "hexToUInt32Color"
  }
]