search

jscs-dev / jscs-jsdoc

JsDoc validation rules for jscs
MIT License
99 stars 35 forks source link

Angular (ngdoc) tag set #151

Open qfox opened 8 years ago

qfox commented 8 years ago

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

/cc @asgeirbirkis

stonecauldron commented 8 years ago

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

bastienmoulia commented 8 years ago

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

"checkAnnotations": {
    "preset": "jsdoc3", 
    "extra": {
        "ngdoc": true,
        "restrict": true
    }
}
damsorian commented 8 years ago

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

gavD commented 8 years ago

@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.

dpalic commented 8 years ago

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

damsorian commented 8 years ago

@gavD , that works for me! thanks!

dpalic commented 8 years ago

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