Feature request, add optional recursion for `generateForDir()` about jsdox

[mrjoelkemp]

Hi @blowsie, I don't quite follow your request. Do you have a specific use-case that clarifies your feature request? Some sample code would also help. Thanks!

[blowsie]

generateForDir() only builds jsdox for the current directory right?

I had to write some code to recursively build the documentation, something like this

console.log("=========== DOCUMENT BUILD STARTED ===========");


jsdox = require("jsdox");
file = require("file");
fs = require("fs");
docsPath = "docs/code/";



deleteFolderRecursive = function(path) {
    var files = [];
    if (fs.existsSync(path)) {
        files = fs.readdirSync(path);
        files.forEach(function(file, index) {
            var curPath = path + "/" + file;
            if (fs.lstatSync(curPath).isDirectory()) { // recurse
                deleteFolderRecursive(curPath);
            } else { // delete file
                fs.unlinkSync(curPath);
            }
        });
        fs.rmdirSync(path);
    }
};

// Remove the directory to clean it up
deleteFolderRecursive(docsPath);

file.walk("app", function(a, dirPath, dirs, files) {


    // Adapt the path
    dirPath = dirPath.replace(/\\/g, "/");

    // Make the directories
    file.mkdirsSync(docsPath + dirPath);

    // Make the docs
    jsdox.generateForDir(dirPath + "/", docsPath + dirPath, done);

});

function done() {
    console.log('=========== DOCUMENT COMPLETE ===========', arguments);
}

I would be great if we could bake something like this into the library to save people having to write code similar to mine.

[mrjoelkemp]

Interesting. I'd been using the glob format in the grunt-jsdox task to process a list of files within a directory. Hadn't used jsdox as a library.

I personally prefer using node-dir to avoid hand-rolling a recursive directory walker.

Maybe @stouf would be interested in tackling this at some point?

[blowsie]

I just read the jsdox documentation and got it working.

Perhaps I too should have used the grunt-jsdox.
After all the description does do what I need it to do.

---

grunt-jsdox

Recursively generates markdown files for your project, using the jsDox parser. Optionally generates a table of contents, and supports git

---

Someone else may have a use for this, but I guess its a bit niche, as grunt will do the job in most scenarios.

Closing for now.