Commit graph

76 commits

Author SHA1 Message Date
HifiExperiments
85157bf496 possible fix for missing jsdoc 2024-11-07 21:00:03 -08:00
22a783b702
Fix recording API documentation not being built 2024-02-23 20:29:05 +01:00
Heather Anderson
60b8d41c16 stripping wallet/marketplace out 2023-05-28 15:12:21 +02:00
c6f1e6410e Updated some URLs, rebranded documentation and changed default metaverse server address 2022-02-09 23:57:24 +01:00
David Rowe
bd812e58aa Change JSDoc plugin to use "/*@jsdoc" tags instead of "/**jsdoc"
So as not to clash with Doxygen.
2021-05-12 10:53:43 +12:00
Julian Groß
b1852eabd4 Update jsdoc entry 2021-04-15 19:45:52 +02:00
David Rowe
ffeb37e7aa Merge remote-tracking branch 'hifi/master' into merge-hifi-master
# Conflicts:
#	CMakeLists.txt
#	README.md
#	cmake/externals/glad32es/CMakeLists.txt
#	cmake/externals/glad41/CMakeLists.txt
#	cmake/externals/glad45/CMakeLists.txt
#	cmake/externals/polyvox/CMakeLists.txt
#	cmake/externals/quazip/CMakeLists.txt
#	cmake/externals/vhacd/CMakeLists.txt
#	cmake/init.cmake
#	cmake/ports/hifi-deps/CONTROL
#	cmake/ports/sdl2/CONTROL
#	cmake/ports/sdl2/disable-hidapi-for-uwp.patch
#	cmake/ports/sdl2/enable-winrt-cmake.patch
#	cmake/ports/sdl2/fix-arm64-headers.patch
#	cmake/ports/sdl2/fix-x86-windows.patch
#	cmake/ports/sdl2/portfile.cmake
#	cmake/ports/sdl2/vcpkg-cmake-wrapper.cmake
#	cmake/ports/tbb/portfile.cmake
#	hifi_vcpkg.py
#	interface/src/avatar/MyAvatar.h
#	libraries/avatars-renderer/src/avatars-renderer/Avatar.h
#	libraries/avatars/src/AvatarData.h
#	libraries/entities-renderer/src/RenderableEntityItem.h
#	libraries/entities/src/EntityItem.cpp
#	libraries/entities/src/EntityItem.h
#	libraries/fbx/src/GLTFSerializer.cpp
#	libraries/graphics-scripting/src/graphics-scripting/Forward.h
#	libraries/networking/src/AddressManager.cpp
#	libraries/networking/src/DomainHandler.h
#	libraries/procedural/src/procedural/ProceduralMaterialCache.cpp
#	libraries/render-utils/src/HighlightEffect.cpp
#	libraries/render-utils/src/MeshPartPayload.cpp
#	libraries/render-utils/src/Model.cpp
#	libraries/render-utils/src/RenderShadowTask.cpp
#	libraries/script-engine/src/WebSocketClass.cpp
2020-04-09 16:46:27 +12:00
Kasen IO
fff819f56c Fix sidebar not showing on first load. 2020-03-27 16:07:59 -04:00
David Rowe
73ad5d1d31 Fix some JSDoc typos noticed in passing 2019-12-10 13:34:32 +13:00
David Rowe
fafb3dd30b MaterialCache JSDoc 2019-11-26 17:43:23 +13:00
Anthony Thibault
f99bb3ec77
Merge pull request #16400 from hyperlogic/feature/arkit-blendshapes
Extended avatar blendshape support for ARKit compatiblity
2019-10-31 12:33:50 -07:00
David Rowe
2591aed686 Exclude AudioScope API from JSDoc output 2019-10-24 09:20:24 +13:00
Anthony J. Thibault
da0911e01b Delete legacy blendshape code
Move FaceshiftConstants to BlendshapeConstants.
Delete FaceTracker and DdeFaceTracker classes.
Delete old facetracker menu and preferences
2019-10-16 10:36:37 -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
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