ingerjm0
5aef2d674a
DOC-69: Move Supported Script Types section to top of JSDoc pages
2019-09-05 10:12:59 -07:00
David Rowe
bce3e9bd6b
PlatformInfo API JSDoc update
2019-07-26 10:32:19 +12:00
David Rowe
ca3f45163f
Merge branch 'master' into M21989
2019-04-11 10:37:34 +12:00
David Rowe
28dfac64ba
Merge branch 'master' into M21460
...
# Conflicts:
# libraries/image/src/image/Image.h
2019-04-05 17:50:46 +13:00
David Rowe
2a17ad3da5
AvatarList and AvatarManager JSDoc
2019-04-04 10:11:54 +13:00
David Rowe
9a1bb27034
AnimationCache, ModelCache, SoundCache, and TextureCache JSDoc
2019-03-26 13:58:43 +13:00
David Rowe
cf4370ed3a
Merge branch 'master' into M21222
2019-03-26 09:44:48 +13:00
David Rowe
025326b85f
Remove custom @signal tag
2019-03-22 12:20:10 +13:00
David Rowe
4c7d5c7da7
Detect signal functions based on their return type
2019-03-22 12:19:20 +13:00
David Rowe
53b5a599b1
Reinstate avatar script type tag
2019-03-15 09:12:16 +13:00
ingerjm0
761a922951
Fixed per code review
2019-02-25 10:43:14 -08:00
ingerjm0
75000d9a79
Add @signal tag to hifi plugin
2019-02-23 21:28:00 -08:00
ingerjm0
36c66f019d
Add @signal tag to jsdoc; use custom jsdoc templates
2019-02-23 21:10:40 -08:00
David Rowe
5428bb19dc
Add "Avatar Script" JSDoc API classification
2019-02-12 11:49:49 +13:00
milad
1a4fa92a29
Merge commit 'refs/pull/13206/head' of https://github.com/highfidelity/hifi into gravprep-redo
2018-05-22 14:33:53 -07:00
David Rowe
e44e7ca35f
Fix up Resource and resource cache APIs' JSDoc
2018-05-21 11:57:16 +12:00
milad
bbb1aa404f
Merge commit 'refs/pull/13165/head' of https://github.com/highfidelity/hifi into gravprep-redo
2018-05-16 23:04:43 -07:00
David Rowe
fdeb0e3305
Avatar API JSDoc stubs
2018-05-16 09:20:54 +12:00
David Rowe
1ca6bd2f0b
location getter/setter JSDoc
2018-05-15 17:37:45 +12:00
milad
4fb479c382
Merge commit 'refs/pull/13165/head' of https://github.com/highfidelity/hifi into gravprep-redo
2018-05-12 23:42:21 -07:00
David Rowe
7cef329939
Render API JSDoc stubs
2018-05-13 11:53:57 +12:00
David Rowe
fb1f7fea90
Steam API JSDoc stubs
2018-05-13 10:32:46 +12:00
David Rowe
11f984f05b
OffscreenFlags API JSDoc stubs
2018-05-12 15:08:41 +12:00
David Rowe
841161068c
Midi API JSDoc stubs
2018-05-12 15:01:52 +12:00
David Rowe
a2bb9de441
Graphics API JSDoc stubs
2018-05-12 12:53:43 +12:00
David Rowe
42d0620fd1
EntityViewer API JSDoc stubs
2018-05-11 20:56:00 +12:00
David Rowe
3891ebe703
Agent API JSDoc stubs
2018-05-11 20:20:07 +12:00
milad nazeri
91c0fa2778
Adding dedent
2018-04-28 12:16:39 -07:00
David Rowe
fada958e72
Handle possibly undefined value
2018-04-28 19:57:45 +12:00
milad nazeri
9773b928ac
copying to dir working
2018-04-28 00:25:07 -07:00
David Rowe
fc4837b51c
Reorder listing of context tags
2018-04-28 16:00:49 +12:00
David Rowe
e39aecfb2a
Fix custom JSDoc tags
2018-04-28 16:00:22 +12:00
Anthony J. Thibault
c6b12307aa
Added custom jsdoc tags to High Fidelity
...
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
*
2018-04-26 14:13:42 -07:00
David Rowe
08dc9b133f
Docs to JSDoc review
2018-04-26 21:10:28 +12:00
MiladNazeri
0f87e53902
Merge pull request #12963 from MiladNazeri/docs/DocsToJSDocsUpdate
...
Docs/docs to js docs update
2018-04-25 12:26:19 -07:00
David Rowe
719062dd9f
Interim JSDoc for MyAvatar - first pass
2018-04-24 09:10:59 +12:00
milad nazeri
e25c871a52
fixing hifi.js
2018-04-23 07:53:46 -07:00
milad nazeri
83523c7052
original doc sources ported
2018-04-23 07:52:21 -07:00
David Rowe
6a2b7244eb
Interim JSDoc for Tablet
2018-04-23 11:06:17 +12:00
milad nazeri
e9b9c05b5d
removed cruft
2018-04-22 08:51:47 -07:00
milad nazeri
dc3d162c5b
working through the list
2018-04-22 08:19:22 -07:00
David Rowe
c1ede6ef58
Merge branch 'master' into 21815
...
# Conflicts:
# tools/jsdoc/plugins/hifi.js
2018-04-17 11:54:56 +12:00
David Rowe
9f83c606e9
Controller API JSDoc
2018-04-17 11:46:40 +12:00
David Rowe
f27e8868eb
Add HMD JSDoc
2018-03-28 12:25:12 +13:00
David Rowe
f9086e31de
Deprecate Entities.getMeshes() in favor of using the new Graphics API
2018-03-01 10:08:50 +13:00
David Rowe
3275846882
Material entity JSDoc
2018-03-01 09:57:42 +13:00
David Rowe
1fb02d15d7
Entities actions JSDoc
2018-02-27 14:12:20 +13:00
David Rowe
a8e05824cd
Entities octree sending functions JSDoc
2018-02-25 14:15:39 +13:00
David Rowe
67cfe783be
Entity properties JSDoc
2018-02-19 12:17:31 +13:00
Thijs Wenker
4ff3c9e046
fix jsdoc output folder
2018-01-22 19:00:45 +01:00