Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-06-04 07:20:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc/hifi-jsdoc-template
History
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
..
static toggle works + viewport restriction removed. 2020-01-30 13:12:46 -05:00
tmpl Merge remote-tracking branch 'hifi/master' into merge-hifi-master 2020-04-09 16:46:27 +12:00
LICENSE.md Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
package.json Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
publish.js API docs rebranding 2020-01-09 10:38:58 +13:00
README.md Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00

README.md

hifi-jsdoc-template

The hifi-jsdoc-template is based on the DocDash template.

Usage

Clone repository to your designated jsdoc/node_modules template directory.

In your config.json file, add a template option.

"opts": {
  "template": "node_modules/hifi-jsdoc-template"
}

Sample config.json

{
    "opts": {
        "template": "node_modules/hifi-jsdoc-template"
    },
    "docdash": {
        "meta": {                       
            "title": "",                
            "description": "",          
            "keyword": ""               
        },
        "search": [true],  
        "collapse": [true],       
        "typedefs": [false]    
    },    
    "templates": {
        "default": {
            "outputSourceFiles": false
        }
    },
    "plugins": [
        "plugins/hifi",
        "plugins/hifiJSONExport"
    ]
}