Using CSDoc from Node

Using CSDoc as a Module

To use CSDoc as a Module you must first install it locally by running npm install csdoc.

var csdoc = require('csdoc');

var options = {
    template: "json"
};

docs = csdoc("###\nMy favorite model.\n###\nclass Model", options, function(err, docs) {
    console.log(docs);
});

See Options

Using CSDoc as a Child Process

var cp = require('child_process');

var csdoc = cp.spawn('csdoc', ['--template', 'json']);

csdoc.stdout.on('data', function(data) {
    console.log('stdout', data.toString());
});

csdoc.stderr.on('data', function(data) {
    console.log('stderr', data.toString());
});

csdoc.on('close', function(code) {
    console.log('csdoc process exited with code ' + code);
});

csdoc.stdin.end("###\nMy favorite model.\n###\nclass Model");

See Arguments