1

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

Community
  • 1
  • 1
cilap
  • 2,215
  • 1
  • 25
  • 51

2 Answers2

3

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" } } } }

You may need to add more entries to the extra section for the tags you use.

gavD_UK
  • 395
  • 5
  • 11
  • GavD_UK: We are using your suggestion, this ruleset is ignoring missing documentation. If we enable "enforceExistence" option, jscs will complain that about missing documentation for the compile function. This function is already documented by angular, it doesn't need any extra documentation from us. Do you have any suggestion? – cilap Jan 13 '16 at 06:43
  • I'm not sure, I'd have to see your project - are you sure you're only applying jscs to your project, and not your dependencies/node_modules etc? – gavD_UK Jan 21 '16 at 13:35
0

Check this issue on jscs-jsdoc. I cann't help with a documentation framework for Angular, but I guess should be fine grunt-ngdocs

Jaime Suncin
  • 333
  • 2
  • 8