wingedfox / dgeni-alive

Live docs on top of dgeni documentation generator
MIT License
26 stars 14 forks source link

Error message saying no module was found #9

Open BadIdeaException opened 8 years ago

BadIdeaException commented 8 years ago

I've noticed I need to mark module definitions as belonging to themselves, i.e.

@ngdoc module
@name MyModule
@module MyModule

or I will get error messages saying No MyModule module found, related components:

Looking at Angular's own documentation, for instance for ngResource, they don't do this. Since looking at Angular's stuff is one of the primary ways of picking up the somewhat sparsely documented ngdoc syntax, this can be really confusing for new users (such as me :) )

I humbly suggest either mentioning that this is necessary in the documentation for dgeni-alive, or fixing it so it can live without the @module MyModule when @ngdoc shows a module is being defined. If it helps any, the offending line seems to be in processors/mappers/api.js

wingedfox commented 8 years ago

It is a kind of a 'known issue', dgeni-packages/ngdoc does not set module name for @ngdoc module annotation and leaves default value.

Should be fixed some day, but i have no good idea how to fix that, feel free to submit a PR.

BadIdeaException commented 8 years ago

Ok if I find some time I'll look into it. Do I understand you right that it's a known issue not with dgeni-alive, but with dgeni-packages?

Nice work on this btw, of all the dgeni tools I tried out I found yours to be by far the most usable. Keep up the good work! :)

wingedfox commented 8 years ago

Hi,

Thanks! =)

Take a look at https://github.com/angular/dgaeni-packages/blob/master/ngdoc/tag-defs/name.js https://github.com/angular/dgeni-packages/blob/master/ngdoc/tag-defs/module.js https://github.com/angular/dgeni-packages/blob/master/ngdoc/tag-defs/ngdoc.js

Dgeni assumes that if no module name specified it takes first folder name as the module name. I do not see a good way to avoid setting of the both @name and @module params.