jscs-jsdoc icon indicating copy to clipboard operation
jscs-jsdoc copied to clipboard

Angular (ngdoc) tag set

Open qfox opened this issue 9 years ago • 7 comments

https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation#angularjs-specific-ngdoc-directives

  • @ngdoc
  • @restrict etc.

/cc @asgeirbirkis

qfox avatar Sep 16 '15 14:09 qfox

This is an issue that would also be useful for me. :+1:

stonecauldron avatar Sep 28 '15 07:09 stonecauldron

You can use the extra features or make a pull request with a new ngdoc preset.

"checkAnnotations": {
    "preset": "jsdoc3", 
    "extra": {
        "ngdoc": true,
        "restrict": true
    }
}

bastienmoulia avatar Sep 30 '15 14:09 bastienmoulia

I have the same problem. How can I ignore ngdoc directives in jscs?

damsorian avatar Oct 18 '15 02:10 damsorian

@cristianurbano 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 avatar Nov 12 '15 13:11 gavD

yes, would be great to get such a support native integrated into jsdoc

dpalic avatar Nov 14 '15 15:11 dpalic

@gavD , that works for me! thanks!

damsorian avatar Nov 14 '15 18:11 damsorian

are there any updates on this issue? Anything which maybe planned for the near future?

dpalic avatar Jun 14 '16 12:06 dpalic