add function

add(line, curData)

Tag.add for @codestart.

Parameters

  1. line {String}:

    Text from @codestart until the end of line.

    For example:

    @codestart javascript
  2. curData {DocObject}:

    DocObject for the block.

    For example:

    {
    type: 'module',
    name: 'my-project/lib/index',
    params: [{
        name: 'myParamString',
        types: [Array]
    }],
    parent: 'my-project/lib',
    src: {
        line: 5,
        codeLine: 22,
        path: 'my-project/lib/index.js'
    },
    body: '\nJavaScript example using this module:\n\n',
    description: 'Main lib module. \n',
    title: '',
    comment: ' '
}

Returns

{Object}:

Custom object.

For example:

{
    type: 'javascript',
    lines: [],
    last: {
        type: 'module',
        name: 'my-project/lib/index',
        params: [
            [Object]
        ],
        parent: 'my-project/lib',
        src: {
            line: 5,
            codeLine: 22,
            path: 'my-project/lib/index.js'
        },
        body: '\nJavaScript example using this module:\n\n',
        description: 'Main lib module. \n',
        title: '',
        comment: ' '
    },
    _last: undefined
}

lines get added by bit-docs-js/tags/codestart.addMore.