I have created a basic project to experiment with grunt-ngdocs (https://www.npmjs.org/package/grunt-ngdocs). But, for some reason, when I attempt to generate documentation, it fails to recognize any comments. Why is this happening? Can someone offer assistance?
Here is the content of my Gruntfile.js:
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
ngdocs: {
options:{dest: 'docs'},
api:{
src:['someCode.js'],
title:'API Documentation'
}
}
});
// Load the plugin that provides tasks.
grunt.loadNpmTasks('grunt-ngdocs');
};
The code in someCode.js is as follows:
/**
*
* This is a sample function
* @param x
* @returns {number}
*/
var myFunc = function(x){
return 2*x;
};
When I run the command "grunt ngdocs" in the console, here is the output:
slc058:ngDocPlay selah$ grunt ngdocs
Running "ngdocs:api" (ngdocs) task
Generating Documentation...
DONE. Generated 0 pages in 7ms.
Done, without errors.