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

jsDoc updates/fixes #598

Merged
merged 3 commits into from
Aug 25, 2023
Merged

jsDoc updates/fixes #598

merged 3 commits into from
Aug 25, 2023

Conversation

Zetaphor
Copy link
Contributor

@Zetaphor Zetaphor commented Aug 25, 2023

This PR updates a number of references to the Vircadia platform in the jsDoc strings, adds two assets to apidocs.overte.org/examples, and fixes a couple typos in existing documentation.

This resolve #523

The changes are as follows:

Fixed URL's pointing to Vircadia CDN

  • Audio.playSound
  • Script.beginProfileRange
  • Script.endProfileRange
  • Entities.EntityProperties-Model
  • Entities.EntityProperties-ParticleEffect
  • Graphics.canUpdateModel
  • AnimationCache.prefetch
  • A comment in PointerEvent.h

Typo fixes (thanks to @alizardguy for catching these!)

  • MyAvatar.getSkeletonOffset was missing a closing parantheses in its example
  • MyAvatar.setSkeletonOffset had a colon where there should have been a comma in its example

Added assets

The following assets were copied into /tools/jsdoc/hifi-jsdoc-template/static/examples in order to support the required jsDoc updates listed above

  • Silly Dance.fbx was copied from overte-content/marketplaceItems/partyBall/entityResources/resources/animations for AnimationCache.prefetch
  • beach-tide-amplified.wav was copied from overte-content/Bazaar/Worlds/Daybreak/content/audio for Audio.playSound

@JulianGro JulianGro added the CR approved This pull request has been successfully code reviewed label Aug 25, 2023
@JulianGro JulianGro merged commit 0590c37 into overte-org:master Aug 25, 2023
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR approved This pull request has been successfully code reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc talk about Vircadia in https://apidocs.overte.org/Script.html
3 participants