Skip to content

module name inference should depend on current directory? #183

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

Open
jfirebaugh opened this issue Oct 12, 2015 · 1 comment
Open

module name inference should depend on current directory? #183

jfirebaugh opened this issue Oct 12, 2015 · 1 comment

Comments

@jfirebaugh
Copy link
Member

A bit of odd behavior from standard JSDoc:

If the module name is not provided, it is derived from the module's path and filename. For example, suppose I have a file test.js, located in the src directory, that contains the block comment /** @module */. Here are some scenarios for running JSDoc and the resulting module names for test.js:

Derived module names if none is provided.

# from src/
jsdoc ./test.js   # module name 'test'

# from src's parent directory:
jsdoc src/test.js # module name 'src/test'
jsdoc -r src/     # module name 'test'

Should documentation.js emulate this?

@tmcw
Copy link
Member

tmcw commented Oct 12, 2015

tbh, I really don't get what modules are getting at - I strongly suspect they're just a closure compiler concept turned into a JSDoc tag.

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

No branches or pull requests

2 participants