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

Make Sandcastle tolerant of JSDoc's new static prefixes. #2759

Merged
merged 2 commits into from
May 28, 2015
Merged

Conversation

emackey
Copy link
Contributor

@emackey emackey commented May 28, 2015

Fixes #2757. There are two parts to this fix.

  1. In the generated types file, the keys have the prefixes removed (since the keys match lowercase snippets of alphanumeric source code, sans punctuation), but the values are real URLs with the prefixes intact. Thus, fragments of text can be matched to both static and non-static member URLs.
  2. Sandcastle's presentation of the matched links was based on the values, not the keys, in order to display the correct casing. Thus the presentation was tweaked to not show the new prefix.

@emackey
Copy link
Contributor Author

emackey commented May 28, 2015

A good test case here is to add this line in Sandcastle's editor and double-click it:

//contains

In the resulting list, Queue.contains is non-static, and Rectangle.contains is static. Both links should work and scroll correctly.

@hpinkos
Copy link
Contributor

hpinkos commented May 28, 2015

Looks good. Thanks @emackey!

hpinkos pushed a commit that referenced this pull request May 28, 2015
Make Sandcastle tolerant of JSDoc's new static prefixes.
@hpinkos hpinkos merged commit 1453d8b into master May 28, 2015
@hpinkos hpinkos deleted the doc-prefixes branch May 28, 2015 19:09
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

Successfully merging this pull request may close these issues.

Static property documentation broke
2 participants