Home

constant: add


  {
    "comment": "/**\r\n * Adds two numbers.\r\n *\r\n * @since 3.4.0\r\n * @category Math\r\n * @param {number} augend The first number in an addition.\r\n * @param {number} addend The second number in an addition.\r\n * @returns {number} Returns the total.\r\n * @example\r\n *\r\n * add(6, 4)\r\n * // => 10\r\n */",
    "meta": {
        "range": [
            356,
            421
        ],
        "filename": "add.js",
        "lineno": 16,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\lodash\\lodash-repo",
        "code": {
            "id": "astnode100000006",
            "name": "add",
            "type": "CallExpression",
            "value": ""
        }
    },
    "description": "Adds two numbers.",
    "since": "3.4.0",
    "tags": [
        {
            "originalTitle": "category",
            "title": "category",
            "text": "Math",
            "value": "Math"
        }
    ],
    "params": [
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "description": "The first number in an addition.",
            "name": "augend"
        },
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "description": "The second number in an addition.",
            "name": "addend"
        }
    ],
    "returns": [
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "description": "Returns the total."
        }
    ],
    "examples": [
        "add(6, 4)\r// => 10"
    ],
    "name": "add",
    "longname": "add",
    "kind": "constant",
    "scope": "global",
    "___id": "T000002R000002",
    "___s": true,
    "filepath": "add.js"
}