JSDoc @name does not recognize the # symbol, or am i doing something wrong?
I want to document a class in javascript that is augmented by a foreign library. This libary adds method to the prototype of my class and static methods too. From the JSDoc documentation i can do this by documenting like this:
@name MyClass.staticMethod
@type Function
@param {String} p1
@return {Number} returnvalue
and for the instance method:
@name MyClass#method
@type Function
@param {String} p1
@return {Number} returnvalue
However the method "method" will never show in the code complete because of the # symbol. How does the webstorm implementation of jsdoc allow to document this kind of features?
Please sign in to leave a comment.
Hi Paulo.
Actually, # symbol in name tag is not supported now, please create a separate request for this.
Regards,
Konstantin
Fixed. See http://youtrack.jetbrains.com/issue/IDEA-90384.