How can I indicate dependencies to external modules?

Question

I'm starting to document my app using ngdoc (a variant of jsdoc). The first thing I'm doing is documenting my main module. This module depends on a bunch of angular modules, e.g. ngAnimate. I'd like to indicate these requirements:

/** 
 * @ngdoc overview
 * @name myApp
 * @requires ngAnimate
 * @requires ngCookies
 ... etc ...
*/

However, this generates a link to http://localhost:9999/#/api/ngAnimate on my server. It assumes, rightly so, that I'm referring to something else in the documentation.

How do I indicate that the requirement is from an external source? e.g. something like:

* @requires {@link https://docs.angularjs.org/api/ngAnimate }

score 0 · Answer 1 · answered Nov 17 '16 at 11:32

0

try that. It's work for me :

* @requires https://docs.angularjs.org/api/ngAnimate

answered Nov 17 '16 at 11:32

Courgette

9
1

not working, this generates the link: `http://localhost:8081/#/https://docs.angularjs.org/api/ngAnimate` – Luis Gonzalez Apr 11 '18 at 18:30

How can I indicate dependencies to external modules?

1 Answers1