ngDoc can't cope with the Angular styleguide

88 views Asked by At

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 here).

However, the officially endorsed Angular styleguide says we should namespace our modules with dots (e.g. app.users).

Now, am I just not getting it, or are those two things mutually exclusive?!?

Is there a way to escape the moduleName for ngDoc? I really don't feel particularly like renaming all my modules (plus, I happen to think the styleguide makes sense)...

1

There are 1 answers

0
BadIdeaException On

Never mind. For anyone coming across this and experiencing the same behavior:

If you happen to be using the grunt-ngdocs plugin, try uninstalling and reinstalling it:

npm remove grunt-ngdocs
npm install grunt-ngdocs