search

braintree / braintree-web-drop-in

Braintree Drop-in for the web
MIT License
200 stars 124 forks source link

docs: fix jsdoc version links and semantics #878

Open cgdibble opened 1 year ago

cgdibble commented 1 year ago

Summary

We were getting broken links in the built docs because we have a placeholder for the SDK version that gets swapped out for the actual version at build time. Some of the JSDoc comments are large enough that ended up with more than one version placeholder, thus a basic use of replace wasn't going to work since it just does the first occurrence.

Specifically:

If pattern is a string, only the first occurrence will be replaced.

So, a basic regex does the trick.

During this exploration, I also noted that the JSDocs were using incorrect semantic JSDoc syntax. For a bunch of type definitions we were using @param instead of the appropriate @property: https://jsdoc.app/tags-typedef.html

Checklist

Authors

List GitHub usernames for everyone who contributed to this pull request.

shango420 commented 1 year ago

cdb906ed4a3b21b948cf62636cd661d9c24db464