Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Angular (ngdoc) tag set #151

Open
qfox opened this issue Sep 16, 2015 · 7 comments
Open

Angular (ngdoc) tag set #151

qfox opened this issue Sep 16, 2015 · 7 comments

Comments

@qfox
Copy link
Member

qfox commented Sep 16, 2015

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

  • @ngdoc
  • @restrict
    etc.

/cc @asgeirbirkis

@qfox qfox added the tag sets label Sep 16, 2015
@stonecauldron
Copy link

This is an issue that would also be useful for me. 👍

@bastienmoulia
Copy link

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
Copy link

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

@gavD
Copy link

gavD commented Nov 12, 2015

@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
Copy link

dpalic commented Nov 14, 2015

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

@damsorian
Copy link

@gavD , that works for me! thanks!

@dpalic
Copy link

dpalic commented Jun 14, 2016

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants