mirror of
https://thingvellir.net/git/overte
synced 2025-03-27 23:52:03 +01:00
c6b12307aa
There are 4 new jsdoc tags:
* @hifi-interface - indicates that this namespace or class is available in Interface Scripts.
* @hifi-assignment-client - indicates that this namespace or class is available in Assignment Client Scripts.
* @hifi-client-entity - indicates that this namespace or class is available in Client Entity Scripts.
* @hifi-server-entity - indicates that this namespace or class is avaialbe in Server Entity Scripts.
These tags should appear just after the @class or @namespace tag. For example:
/**jsdoc
* Your avatar is your in-world representation of you. The <code>MyAvatar</code> API is used to manipulate the avatar.
* For example, you can customize the avatar's appearance, run custom avatar animations,
* change the avatar's position within the domain, or manage the avatar's collisions with other objects.
*
* @namespace MyAvatar
*
* @hifi-interface
* @hifi-client-entity
*
|
||
|---|---|---|
| .. | ||
| plugins | ||
| .gitignore | ||
| CMakeLists.txt | ||
| config.json | ||
| package.json | ||
| README.md | ||
| root.js | ||
#JavaScript Documentation Generation
##Prerequisites
- Install node.js
- Install jsdoc via npm.
npm install jsdoc -g
To generate html documentation for the High Fidelity JavaScript API:
cd tools/jsdocjsdoc . -c config.json
The out folder should contain index.html.