Skip to content
This repository has been archived by the owner on Dec 4, 2018. It is now read-only.

Accept slash as <namepath> #100

Closed
Constellation opened this issue Dec 23, 2014 · 6 comments
Closed

Accept slash as <namepath> #100

Constellation opened this issue Dec 23, 2014 · 6 comments

Comments

@Constellation
Copy link
Member

spawn from eslint/eslint#1598.

Doctrine rejects the following comments.

/**
 * Base component implementation.
 *
 * @constructor
 * @extends module:stb/emitter~Emitter
 */

This is because doctrine doesn't support

  • / as namepath
  • @extends <namepath> syntax
@nzakas
Copy link
Member

nzakas commented Feb 22, 2015

Any plans to fix this?

@morlay
Copy link

morlay commented Mar 3, 2015

When i try to fix this, I found it is not easy to cover all available chars for path.
maybe we can discuss that, which special char can be use in path,

space char is not allowed, that will change too much things.
and now, lodash(_), dash(-) , blackslash() and slash(/) can be used,

dot(.) should be allowed, too.

and any others ?

@nzakas
Copy link
Member

nzakas commented Mar 21, 2015

@Constellation are you still planning on fixing this?

@Constellation
Copy link
Member Author

I'll check it.

@JohnAlbin
Copy link

I'm seeing this same error with @alias, e.g. @alias module:mymodule/mymodule.init. Which works fine in the latest jsdoc package.

@avsmithy
Copy link

avsmithy commented Jun 2, 2015

I'm also seeing this issue when using @alias with a '/' and eslint valid-jsdoc.

ryanjduffy pushed a commit to ryanjduffy/doctrine that referenced this issue Feb 12, 2016
ryanjduffy pushed a commit to ryanjduffy/doctrine that referenced this issue Feb 12, 2016
@nzakas nzakas closed this as completed in b082f85 Feb 15, 2016
nzakas added a commit that referenced this issue Feb 15, 2016
Fix #100: add support for forward slash in namepaths
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants