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

Instance members starting with a hash are not documented correctly. #2082

Open
lunarnull opened this issue Sep 18, 2023 · 1 comment
Open

Comments

@lunarnull
Copy link

Input code

/**
 * {@link Test#"#memberA"}, {@link Test#"#memberB"}, {@link Test#"#memberC"}
 * @public
 * @class Test
 */
function Test() {
	/**
	 * @memberOf Test
	 * @public
	 * @instance
	 * @member {*} "#memberA"
	 */
	this["#memberA"] = 1;

	/**
	 * @public
	 * @member {*} Test#"#memberB"
	 */
	this["#memberB"] = 2;
};

/**
 * @public
 * @instance
 * @member {*}
 */
Test.prototype["#memberC"] = 3;

JSDoc configuration

No custom configuration used.

JSDoc debug output

DEBUG: JSDoc 4.0.2 (Sun, 19 Feb 2023 23:01:18 GMT)
DEBUG: Environment info: {"env":{"conf":{"plugins":[],"recurseDepth":10,"source":{"includePattern":".+\\.js(doc|x)?$","excludePattern":"(^|\\/|\\\\)_"},"sourceType":"module","tags":{"allowUnknownTags":true,"dictionaries":["jsdoc","closure"]},"templates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles":true}}},"opts":{"_":["aa.js"],"debug":true,"destination":"./out/","encoding":"utf8"}}}
DEBUG: Parsing source files: ["/tmp/test/aa.js"]
Parsing /tmp/test/aa.js ...
DEBUG: Finished parsing source files.
DEBUG: Adding inherited symbols, mixins, and interface implementations...
DEBUG: Adding borrowed doclets...
DEBUG: Post-processing complete.
Generating output files...
Finished running in 0.22 seconds.

Expected behavior

JSDoc documents the members "#memberA", "#memberB", and "#memberC" under the class Test. Links in the Test class' comment resolve properly.

Current behavior

JSDoc documents a member called Test"#memberA" in the class Test, and Test"#memberB" in the global scope. "#memberC" is documented correctly under Test. Only the Test#"#memberC" link renders as a usable link.

Your environment

Software Version
JSDoc JSDoc 4.0.2 (Sun, 19 Feb 2023 23:01:18 GMT)
Node.js v12.22.9
npm N/A
yarn 1.22.10
Operating system Pop!_OS (Debian-like, Linux)
@lunarnull lunarnull reopened this Sep 18, 2023
@lunarnull
Copy link
Author

Sorry, that was a misclick.

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

1 participant