Commit graph

183 commits

Author SHA1 Message Date
ingerjm0
b8b7dbf681 DOC-148: Increase size of monospace type 2019-09-05 13:39:06 -07:00
ingerjm0
d8c655a151 Fixed spacing issues in navigation caused by fix to to DOC-156 2019-09-05 11:42:34 -07:00
ingerjm0
af7e68786a DOC-156 (comment): Fixed spacing on non-paragraph text 2019-09-05 11:29:13 -07:00
ingerjm0
9bf579d878 DOC-156: Fix font size issues on non-paragraph text 2019-09-05 11:08:25 -07:00
ingerjm0
5ebf141d73 DOC-67: Incorrect location of example code for Avatar API 2019-09-05 10:39:18 -07:00
ingerjm0
2502abe963 Merge branch 'master' of https://github.com/highfidelity/hifi into api-docs 2019-09-05 10:17:38 -07:00
ingerjm0
5aef2d674a DOC-69: Move Supported Script Types section to top of JSDoc pages 2019-09-05 10:12:59 -07:00
David Rowe
233a1528df Add support for examples in API description section 2019-08-27 09:24:01 +12:00
ingerjm0
7ffcee35dd Fix formatting in API docs (DOC-112, DOC-113, DOC-142, DOC-143) 2019-08-22 15:37:34 -07:00
David Rowe
11f8387a5a Fix typo noticed in passing 2019-08-17 16:56:35 +12:00
David Rowe
dbb964d415 Report type of callback as "function" in JSDoc 2019-08-17 16:56:01 +12:00
David Rowe
ed6407d2bd Fix callback functions' display in JSDoc 2019-08-16 21:07:34 +12:00
David Rowe
bce3e9bd6b PlatformInfo API JSDoc update 2019-07-26 10:32:19 +12:00
jennaingersoll
938b9e25f9
Merge pull request #15861 from jennaingersoll/signal-fix
DOC-66: Show deprecated notices for signals.
2019-07-02 10:21:56 -07:00
ingerjm0
292dce3e88 DOC-66: Show deprecated notices for signals. 2019-07-01 14:38:56 -07:00
Christoph Haag
bd22baad72
Update jsdoc to avoid breakage with recent node 2019-06-18 16:26:30 +02: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
Shannon Romano
82a8a79172
Merge pull request #15229 from ingerjm0/api-docs
JSDoc template and branding changes
2019-04-04 16:51:33 -07:00
ingerjm0
3dbb2b1812 Fix build error for template changes 2019-04-04 15:08:39 -07: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
ingerjm0
2b858c4ef5 Show deprecated statement in method details 2019-03-22 11:56:29 -07:00
ingerjm0
ba9426e14e Fixed font size in docs 2019-03-22 11:56:04 -07:00
ingerjm0
7c10fde517 Fix attributes not showing up 2019-03-22 10:34:18 -07:00
ingerjm0
33036bc867 Review of api main page 2019-03-22 10:33:47 -07:00
David Rowe
ba0923a3ad Fix signal summary text 2019-03-22 12:20:22 +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
ingerjm0
76bc5c52a7 Template fixes for new API system 2019-03-20 10:20:30 -07:00
ingerjm0
b10eb4e1d9 Add intro page to API docs 2019-03-20 10:14:32 -07:00
ingerjm0
5271d2b7c8 JSDoc template updates for branding 2019-03-20 10:13:53 -07:00
David Rowe
f0bbd89546 Update JSDoc README with solution for out-of-memory problem 2019-03-15 11:05:58 +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
Anthony Thibault
9a0163f404 Add README.md file to tools/jsdoc/out directory to prevent jsdoc generation failures during build 2019-02-19 10:36:35 -08:00
David Rowe
5428bb19dc Add "Avatar Script" JSDoc API classification 2019-02-12 11:49:49 +13:00
ingerjm0
a8d89370a7 Revert "adding new pages"
This reverts commit 5e2bde0b57.
2019-01-11 16:15:07 -08:00
ingerjm0
5e2bde0b57 adding new pages 2019-01-11 16:12:37 -08:00
ingerjm0
8b111587ad JSDoc > Grav directory change 2019-01-11 14:38:20 -08:00
milad
023594ff17 Fixed Readme instructions on JSDoc 2018-07-02 10:59:08 -07:00
milad
42ea7f358a added root.js to cmake build 2018-05-29 15:39:04 -07:00
milad
a048f6f7d5 indent fix 2018-05-29 14:48:52 -07:00
milad
301aba06a3 modified git ignore 2018-05-29 14:39:10 -07:00
milad
6a8fa3a15a Added edits to readme 2018-05-29 14:35:33 -07:00
milad
4b4f6e0f02 cleaned up file cruft 2018-05-29 13:31:13 -07:00
milad
9c664a2512 Cleaned up gravprep.js 2018-05-29 11:24:13 -07:00
milad
e57bba1c08 more cleanup 2018-05-29 09:35:22 -07:00
milad
ded774de9c multiple fixes for repeated type defs 2018-05-22 16:02:29 -07: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
milad
5056e698fa further clean up 2018-05-21 22:10:57 -07:00
milad
3450af7a3d clean up 2018-05-21 21:52:20 -07:00
milad
24262e97a6 removed old cruft 2018-05-21 09:10:30 -07:00
milad
9c0bd89951 another round of fixing and merging 2018-05-21 09:09:18 -07:00
milad
73dd5c7f36 fixed merge 2018-05-21 08:21:47 -07:00
milad
1e4d4dac44 cleaned up script 2018-05-20 23:39:47 -07:00
milad
e436f65d4c reworking gravprep to fix most links and oddities 2018-05-20 23:32:18 -07:00
milad
8e50c0fd56 Added pre typedef splits 2018-05-20 20:40:23 -07:00
David Rowe
e44e7ca35f Fix up Resource and resource cache APIs' JSDoc 2018-05-21 11:57:16 +12:00
milad
23ee06fc4b fixed class links 2018-05-20 14:35:58 -07:00
milad
0ccb233724 gravprep redo for link fixes 2018-05-20 14:18:39 -07:00
milad
46efb2b868 merging onto mac 2018-05-19 22:44:18 -07: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
milad
091c2c8b98 Before David's latest stubs 2018-05-12 23:41:56 -07:00
David Rowe
7cef329939 Render API JSDoc stubs 2018-05-13 11:53:57 +12:00
milad
2b7e217c35 Fixed Asset Class 2018-05-12 15:45:27 -07: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
c822e836bc general format work 2018-05-08 21:48:57 -07:00
milad nazeri
f72e7d8c01 updating for workPC 2018-05-08 13:09:41 -07:00
milad nazeri
6cb4901bae fixed undefined errors 2018-05-07 15:49:53 -07:00
milad nazeri
22065ad611 Links fixed 2018-05-06 21:39:37 -07:00
milad nazeri
ae935dcda5 saved before laptop acts up more 2018-05-01 16:23:50 -07:00
milad nazeri
8845094afb Added Lod fix 2018-04-30 16:55:42 -07:00
milad nazeri
f520d13242 pre TOC add 2018-04-30 16:32:15 -07:00
milad nazeri
1ce4c9d140 GravPrep working through first round of editing, starting explore file and jsdoc quality tests 2018-04-29 14:52:56 -07:00
milad nazeri
f35fffb975 Added toc 2018-04-28 13:55:42 -07:00
milad nazeri
91c0fa2778 Adding dedent 2018-04-28 12:16:39 -07:00
milad nazeri
9db67229b9 Name groupings working correctly, pre-adding ctrlAtlDavid's new tags 2018-04-28 09:29:16 -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