Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error message saying no module was found #9

Open
BadIdeaException opened this issue Jun 16, 2016 · 3 comments
Open

Error message saying no module was found #9

BadIdeaException opened this issue Jun 16, 2016 · 3 comments

Comments

@BadIdeaException
Copy link

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
Copy link
Owner

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
Copy link
Author

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
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants