jsDoc: Use jsDoc syntax to document function names, description, params and returns
/**
* @name SomeService
* @desc Main application Controller
*/
function SomeService (SomeService) {
/**
* @name doSomething
* @desc Does something awesome
* @param {Number} x - First number to do something with
* @param {Number} y - Second number to do something with
* @returns {Number}
*/
this.doSomething = function (x, y) {
return x * y;
};
}
angular
.module('app')
.service('SomeService', SomeService);