Stack Overflow
Stack Overflow

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
2
votes
2 answers

How to describe angular controller methods in documentation?

I can't describe controllers methods. How i can do this? /** * @ngdoc controller * @name works.controller:worksCtrl * @requires $http * @requires $element * @function * * @description * Description for works controller. All methods will be writen…
Andrey Vaganov
  • 1,684
  • 1
  • 12
  • 18
2
votes
1 answer

How can a ngdoc root/overview page be defined?

I have a working documentation page with a API Documentation section and a Tutorial section. When I click Tutorial in the breadcrumb navigation, a blank page appears in the content area and the browser title bar says "core-js: Error: Page Not…
Tsunamis
  • 5,870
  • 1
  • 20
  • 22
2
votes
1 answer

How to use ngDoc comments for routeConfig

I am trying to document my Angular WebApp using ngdocs and grunt. I want to know that is there a way to document a route configuration because I feel that my routing system of WebApp if fairly complex and it needs some attention in its documentation…
Ankit Tanna
  • 1,779
  • 8
  • 32
  • 59
1
vote
0 answers

ngDoc @param {type} - the type is not rendered in documentation output

I am using dgeni to document my angular 1.5.x project, wherever I have used @param {type} name description the type is not rendered on the output. I have followed the installation steps of dgeni from this tutorial. Please let me know what I am…
Satyaki
  • 751
  • 2
  • 10
  • 25
1
vote
1 answer

How to make dgeni/ngdoc generate hash-bang links for ngrouter?

I'm creating docs using ng-router in non-html5 mode. All links should be converted to href="#!/path". By default tag {@link} creates href="path". Is ths behaviour configurable?
QwiglyDee
  • 789
  • 8
  • 18
1
vote
0 answers

ngdoc example block not working if i add angular material as dependency

My grunt ngdocs task below. ` ngdocs: { options: { dest: 'site/docs', html5Mode: false, startPage: '/api', scripts: [ …
balachander j
  • 53
  • 1
  • 1
  • 6
1
vote
1 answer

How do I run ng-docs through webpack?

I recently decided to embrace webpack for a majority of my JavaScript related builds and bundles, but there is one part that I have never been able to figure out: How do I run ng-docs using webpack? I am aware of ng-docs being able to be run through…
ryanlutgen
  • 2,951
  • 1
  • 21
  • 31
1
vote
1 answer

Index.html is not loading with data after running gulp ngdocs command

I have executed gulp ngdocs command and docs folder got created within the project folder structure.when I try to run the index.html the data is not getting loaded but when I try to run one of the js file present in the partials folder the data is…
Raphael
  • 1,738
  • 2
  • 27
  • 47
1
vote
0 answers

angular-jsdoc - How to desribe $broadcast

I have a service named 'utils'. This service have some methods. Also, this service fire 2 broadcasts: "authUtilsFailed" and "authUtilsLoaded". How can I document those 2 broadcasts ? (Using angular-jsdoc) angular.module('myApp') …
KfirZuberi
  • 51
  • 7
1
vote
1 answer

ngdocs - how to add styles to live demo example

I'd like to add my css stylesheets to the live demo examples in the ngdocs documentation. I want the styles to affect the demo itself, but obviously, they should not affect the entire web page. I tried adding my stylesheet to the gruntfile ngdocs…
code2b
  • 132
  • 2
  • 3
  • 11
1
vote
2 answers

JSCS checks for ngdocs?

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…
cilap
  • 2,215
  • 1
  • 25
  • 51
1
vote
0 answers

NGDOC - top-down hierarchy

I have a large AngularJS project which is documented with NGDOC. We have lots of forms, and specific directives can be included only in specific forms. This is now documented as dependencies - each directive has @requires…
Petr Osipov
  • 621
  • 6
  • 16
1
vote
0 answers

A 'documentation coverage' of grunt-ngdocs

To generate the documentation of my project I use ng-docs: https://github.com/m7r/grunt-ngdocs I would like to have a report of which elements (controllers, directives,...) are not yet documented using grunt-ngdocs. Ideally this report could be…
miguelr
  • 1,334
  • 14
  • 21
0
votes
1 answer

Defining type of parameter for the directive

How to define the types of parameters for the directive in angularjs? What type to use for & binding? See ngdoc or jsdoc in example code. UPD: My goal is to get answers on below questions * @param {<< what to write here? >>}…
eustatos
  • 686
  • 1
  • 10
  • 21
0
votes
1 answer

generating gulp-angular documentation with generator-ngdoc

I am having a hard time generating documentation for my gulp-angular based project: I am using this generator to generate a docs folder inside of my project: generator-ngdoc (dgeni based). Whenever I open the documentation for a component I am…
radtelbi
  • 635
  • 1
  • 6
  • 18
1
2
3