-
Notifications
You must be signed in to change notification settings - Fork 0
Some questions keep popping up. Here are the canonical answers.
A: Use the --ext-namespaces=Ext,YourNamespace option to make the parser understand both Ext.define() and YourNamespace.define().
A: First off, see if you can extend JSDuck by by yourself by implementing a custom tag.
If this didn't work out, or you think it would be a generally useful feature, post a new issue and try to convince us that JSDuck should support it. Is it supported by some other documentation tool? Tell us which one and link to the relevant documentation if possible. Is it used by some major JavaScript project? Again, give us examples and links.
A: JSDuck is focused on documenting JavaScript source code (with some rudimentary support for documentation in CSS and SCSS files), if you're trying to run JSDuck over the source code of any other language, you're just asking for trouble. Even if it works, that's just pure luck, and it's probably not going to work in the next major JSDuck release that's going to have a much stricter JavaScript parser.
A: JSDuck expects all member names to be proper JavaScript identifier names. This means only 0...9, A...Z, a...z, _ and $. Class names can additionally contain dots (.). Anything else that happens to work should be considered a bug and not relied on.
Here's a separate article about the reasons for not supporting other characters.