Commit graph

194 commits

Author SHA1 Message Date
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
7087abd201 Merge branch 'master' into 21815 2018-04-21 10:49:56 +12:00
John Conklin II
d19bb557ad
Merge pull request #12897 from ctrlaltdavid/21848
Include JSDoc Web pages in the install
2018-04-18 10:49:31 -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
06bb873e8d Include JSDoc Web pages in the install 2018-04-16 16:08:26 +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
c46a115000 attempt to fix ubuntu build 2018-01-24 01:45:53 +01:00
Thijs Wenker
79dbde6a6f optional auto-complete build (requires NPM installed) 2018-01-23 23:01:59 +01:00
Thijs Wenker
5885569644 fix UNIX jsdoc command order 2018-01-23 01:29:52 +01:00
Thijs Wenker
4ff3c9e046 fix jsdoc output folder 2018-01-22 19:00:45 +01:00
Thijs Wenker
58216b947c removal of unnecessary JS export (for now) 2018-01-22 18:54:24 +01:00
Thijs Wenker
483074b11e jsdoc cmake fixes 2018-01-22 17:59:01 +01:00
Thijs Wenker
0f7f58417b JS scripting console auto-complete 2018-01-19 19:11:12 +01:00
David Rowe
cd2922a560 Merge branch '21602' into 21624
# Conflicts:
#	tools/jsdoc/plugins/hifi.js
2017-11-28 17:04:59 +13:00
David Rowe
de49fefc61 Merge branch 'master' into 21602
# Conflicts:
#	libraries/shared/src/RegisteredMetaTypes.h
2017-11-25 17:06:36 +13:00
David Rowe
91671722a5 Add Shape API types JSDoc 2017-11-25 16:09:54 +13:00
SamGondelman
8730a26d20 use mouse events for offscreenui because touch events aren't working with the eventFilter, cleanup, documentation 2017-11-15 14:12:16 -08:00
David Rowe
39ccd7d656 Update JSDoc for Camera API 2017-11-12 11:04:35 +13:00
David Rowe
a482b7c371 Fix up JSDoc tool readme file 2017-11-10 17:09:45 +13:00
Anthony J. Thibault
f7de74109b Added jsdoc documentation for some of MyAvatar properties and methods 2017-03-24 15:10:26 -07:00
Anthony J. Thibault
01abb4bdb6 Exposed DebugDraw interface to Java Script 2017-03-01 13:14:29 -08:00
Anthony J. Thibault
0c8105b551 Revert "Merge pull request #9141 from hyperlogic/feature/my-avatar-docs-part-1"
This reverts commit 934148fea5, reversing
changes made to d2b32c3084.
2016-12-05 15:17:53 -08:00
Anthony J. Thibault
35eeaad590 Added jsdocs for MyAvatar
Not complete by any means, but it's a start.
2016-12-01 17:38:43 -08:00
Ryan Huffman
c6b64081fc Add Overlays jsdocs 2016-11-16 12:01:05 -08:00
Ryan Huffman
5fd1ae64b0 Begin adding entities jsdoc 2016-11-14 16:54:55 -08:00
Anthony J. Thibault
d111f7c409 Moved jsdoc folder from scripts to tools directory 2016-11-10 09:33:56 -08:00