Static property documentation broke

[emackey]

At some point since 1.9 (and there's been npm package upgrades since then), the links to static properties broke in the docs, in particular Camera.DEFAULT_VIEW_RECTANGLE. In master, these links now get a leading period, which breaks old bookmarked URL hashes, and also breaks the Sandcastle hookup.

For example, in tag 1.9 running locally, this works:

http://localhost:8080/Build/Documentation/Camera.html#DEFAULT_VIEW_RECTANGLE

But in master, the link is broken, and the only working one has a stray dot in it:

http://localhost:8080/Build/Documentation/Camera.html#.DEFAULT_VIEW_RECTANGLE

Not sure if this is a show stopper, but I would love to see this fixed before the release. I'm still researching this myself but welcome any ideas.

[mramato]

We should definitely fix this. I would start by actually upgrading NPM again to the latest jsdoc, just in case this was a beta issue that got fixed in the initial release (which is now out). We can also try downgrading to whatever version we were suing in 1.8 and see if that fixes it, just to confirm that's the problem.

[emackey]

Turns out this is an intentional change on JSDoc's part, see their issue 539 for info. I will need to fix Sandcastle's doc system to accept the change.

[mramato]

I guess this will affect bookmarked doc links on the website as well, right? Though since it's just the fragment that has changed, it's probably not a big deal, since they'll still get to the correct page.

[emackey]

Correct, existing links will get to the right page, but not scroll to the particular static entry. I temporarily put a ++ in my fix and counted that this issue changes 1065 links. In the past couple years I've posted several of these links to the forum and Stack Overflow and other places; I know you have too. There's no URL rewrite rule to help, because the hash stays client side. Still, impact is relatively minor in the grand scheme of things, as people can always scroll the page and look. And if we ever need separate bookmarks for static and non-static versions of the same id on the same class, then we're all set, for what that's worth.