Questions tagged [ngdoc]

Inline language for documenting angularjs applications

ngdoc is based on JSDoc and includes the following AngularJS specific tags:

@ngdoc           specifies the type of thing being documented. See below for more detail.
@scope           specifies that the documented directive will create a new scope
@priority        specifies the documented directive's priority
@animations      specifies the animations that the documented directive supports
@methodOf type   links a method to the object/service where it is defined
@propertyOf type links a property to the object/service where it is defined
@eventOf type    links a method to the object/service where it is defined
@eventType emit | broadcast specifies whether the event is emitted or broadcast

References

35 questions
0
votes
1 answer

Unable to view descriptions of generated docs

although I'm able to serve from filesystem the grunt-ngdocs automatically generated index.html, everytime I try to look to a description in the documentation I'm getting: XMLHttpRequest cannot load file:///C:/ Cross origin requests are…
Gargaroz
  • 313
  • 9
  • 28
0
votes
1 answer

ngDoc can't cope with the Angular styleguide

I have just taken a look at ngDoc, and even though documentation is sparse, I understand it needs a very specific namespacing syntax in the @name tag, for instance moduleName.directive:directiveName in the case of a directive (gleaned this from…
BadIdeaException
  • 2,125
  • 15
  • 32
0
votes
0 answers

Document jQuery widgets using @ngdoc

How do I document jQuery widgets using gulp-ngdoc? I have something like this: /** * @ngdoc widgets * @name XXX.YYY * @description * This is a jQueryUI widget to provide... * * @namespace XXX.YYY */ ...and I get following error: [Error:…
SOReader
  • 5,697
  • 5
  • 31
  • 53
0
votes
1 answer

NGDoc No template found for method

Title pretty much sums it up, if I comment my file like so: /** * @ngdoc method * @name processData.getProcessCategories * @module bpui * * @description Gets the processes from the API * @returns {HttpPromise} …
Mathew Berg
  • 28,625
  • 11
  • 69
  • 90
0
votes
2 answers

AngularJS function parameter hint in webstorm?

I'm using OSX 10.10, Webstorm 10.0.4, AngularJS 1.4.3 For example: .factory('huodai.order.BatchPlanModel', function () { var BatchPlanModel = function (date, batches) { date = date || ""; batches = batches || {}; …
addlistener
  • 871
  • 1
  • 12
  • 20
1 2
3