ngdoc | 易学教程

JSCS checks for ngdocs?

阅读更多关于 JSCS checks for ngdocs?

问题 Wondering if there are any JSCS checks for ngdocs? Alternatively which documentation framework do you suggest for AngularJS code and the possibility to check if code is documented well? maybe related to this: A 'documentation coverage' of grunt-ngdocs 回答1: I managed to get this working with the following .jscsrc: { "preset": "google", "maximumLineLength": 120, "disallowMultipleVarDecl": false, "jsDoc": { "checkAnnotations": { "preset": "jsdoc3", "extra": { "ngdoc": "some", "methodOf": "some"

A 'documentation coverage' of grunt-ngdocs

阅读更多关于 A 'documentation coverage' of grunt-ngdocs

问题 To generate the documentation of my project I use ng-docs: https://github.com/m7r/grunt-ngdocs I would like to have a report of which elements (controllers, directives,...) are not yet documented using grunt-ngdocs. Ideally this report could be added directly into the documentation, or in a way to locate easily the files which are missing documentation. Does such a grunt task or plugin exist? 来源： https://stackoverflow.com/questions/31176956/a-documentation-coverage-of-grunt-ngdocs

How to document a factory that returns a class in angular with ngdoc?

阅读更多关于 How to document a factory that returns a class in angular with ngdoc?

问题 Given an angular app with a factory that returns a class, as such: angular.module('fooApp').factory('User', function(){ function User(name){ this.name = name; } User.prototype.greet = function(){ return "Howdy, " + this.name; } return User; }); Using ngdoc (the special flavor of jsdoc angular uses), how do I document the initializer without defining it as a method? Right now, this is what I've tried: /** * @ngdoc service * @name fooApp.User * @description User factory. */ angular.module(

grunt-ngdocs: styles file not included to demo code

阅读更多关于 grunt-ngdocs: styles file not included to demo code

问题 I am using grunt-ngdocs to document my Angular project. But the demo Plunker code (generated automatically) doesn't include the CSS file. My configuration in Gruntfile.js includes: ... scripts: [ 'https://code.jquery.com/jquery-2.1.4.js' ], styles: [ 'https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.0.7/semantic.css' ] ... In my JS src file: @example <example module="sui.checkbox"> <file name="index.html"> ... </file> <example> On the API page, the JS and CSS files are loaded correctly.

How to document a factory that returns a class in angular with ngdoc?

阅读更多关于 How to document a factory that returns a class in angular with ngdoc?

Given an angular app with a factory that returns a class, as such: angular.module('fooApp').factory('User', function(){ function User(name){ this.name = name; } User.prototype.greet = function(){ return "Howdy, " + this.name; } return User; }); Using ngdoc (the special flavor of jsdoc angular uses), how do I document the initializer without defining it as a method? Right now, this is what I've tried: /** * @ngdoc service * @name fooApp.User * @description User factory. */ angular.module('fooApp').factory('User', function(){ /** * @ngdoc method * @methodOf fooApp.User * @name Initializer *