diff --git a/tools/jsdoc/Check.js b/tools/jsdoc/Check.js index af449dafc1..8005db743a 100644 --- a/tools/jsdoc/Check.js +++ b/tools/jsdoc/Check.js @@ -1,18 +1,20 @@ var fs = require('fs'); var path = require('path'); var request = require('request'); +var axios = require('axios'); var badLinks = []; -var baseLink = `http://localhost:8000/api-reference/`; +// var baseLink = `http://localhost:8000/api-reference/`; +var baseLink = `https://docs.highfidelity.com`; var linkList = fs.readFileSync(__dirname + '/Links-Untouched','utf8').split('\n'); -console.log("link list", linkList); +// console.log("link list", linkList); // console.log("filtered List", JSON.stringify(filteredList)); var linkHash = {}; var currentGroup; linkList.forEach( link => { link = link.trim() - console.log("link", link) + // console.log("link", link) if (link.slice(-1) === ':'){ currentGroup = link.slice(0, link.length-1); // console.log("current Group: ", currentGroup); @@ -35,37 +37,39 @@ var keys = Object.keys(linkHash); keys.forEach( key => { for (var linkKey in linkHash[key]){ var link = linkHash[key][linkKey]; - console.log("link", link); + // console.log("link", link); var extractLink = link.split(`"`)[1]; - console.log("extractLink", extractLink) - if (!extractLink.indexOf('http') > -1){ - extractLink = baseLink + extractLink; - } - console.log("about to make a request for", extractLink) - setTimeout(function(){ - request.get(extractLink) - .on('response', response => { - if (response.statusCode(404)){ - console.log("found bad link") - console.log(JSON.stringify({file: key, link: extractLink})) - - // badLinks.push({file: key, link: link}) - stream.write(JSON.stringify({file: key, link: extractLink})); - } - }, 4000) - }) - } + if (!(extractLink.indexOf(':') > -1)){ + console.log(" adding link") + extractLink = baseLink + extractLink; + } else { + // console.log("found https") + } + console.log("extractLink", extractLink) -}) + // console.log("about to make a request for", extractLink) + axios.get(extractLink) + .then( response => { + console.log("response") + if (response.status === 404){ + console.log("found bad link") + // console.log(JSON.stringify({file: key, link: extractLink})) + // stream.write(JSON.stringify({file: key, link: extractLink})); + } + }) + .catch( error => { + console.log("error") + // console.log(error); + // if (error.response.status === 404){ + // console.log("found bad link") + // console.log(JSON.stringify({file: key, link: extractLink})) + // stream.write(JSON.stringify({file: key, link: extractLink})); + // } + }) + } + }) stream.end(); -// */ - -/* - -*/ - - function endsWith(path, exts) { var result = false; diff --git a/tools/jsdoc/Links-Untouched b/tools/jsdoc/Links-Untouched index 9da3060726..bea2009fa5 100644 --- a/tools/jsdoc/Links-Untouched +++ b/tools/jsdoc/Links-Untouched @@ -7,10 +7,18 @@ AnimationCache: Resource Assets: Assets~downloadDataCallback +Assets.GetOptions +Assets.GetOptions Assets~getAssetCallback Assets~getMappingCallback +Assets.PutOptions Assets~setMappingCallback Assets~uploadDataCallback +Assets.getAsset +Assets.putAsset +Assets.putAsset +Assets.getAsset +Assets.putAsset AudioStats: AudioStats.AudioStreamStats AudioStats.AudioStreamStats @@ -40,55 +48,165 @@ AvatarManager: Camera: Vec3 Quat +Camera.Mode ViewFrustum Uuid PickRay PickRay PickRay +Entities.findRayIntersection +Overlays.findRayIntersection PickRay PickRay Uuid Uuid +Camera.Mode +Camera.Mode Quat Quat Vec3 Vec3 Vec3 Vec3 +Camera.Mode Uuid +Camera.Mode Quat Vec3 Clipboard: Uuid Vec3 Vec3 +Clipboard.exportEntities Uuid Vec3 Uuid Controller: - MyAvatar.sessionUUID + getActions +getHardware +getStandard +disableMapping +enableMapping +loadMapping +newMapping +parseMapping +findAction +findDevice +getActionNames +getAllActions +getAvailableInputs +getDeviceName +getDeviceNames +actionEvent +hardwareChanged +inputEvent +keyPressEvent +keyReleaseEvent +mouseDoublePressEvent +mouseMoveEvent +mousePressEvent +mouseReleaseEvent +touchBeginEvent +touchEndEvent +touchUpdateEvent +wheelEvent +captureMouseEvents +captureTouchEvents +captureWheelEvents +releaseMouseEvents +releaseTouchEvents +releaseWheelEvents +captureActionEvents +captureEntityClickEvents +captureJoystick +captureKeyEvents +releaseActionEvents +releaseEntityClickEvents +releaseJoystick +releaseKeyEvents +getValue +getAxisValue +getgetPoseValue +getButtonValue +getAxisValue +getPoseValue +getActionValue +triggerHapticPulse +triggerHapticPulseOnDevice +triggerShortHapticPulse +triggerShortHapticPulseOnDevice +getViewportDimensions +getRecommendedHUDRect +setVPadEnabled +setVPadHidden +setVPadExtraBottomMargin +startInputRecording +stopInputRecording +saveInputRecording +getInputRecorderSaveDirectory +loadInputRecording +startInputPlayback +stopInputPlayback +Entities.callEntityMethod +MyAvatar.sessionUUID +Controller.Actions RouteObject keyboardMouse.json standard.json +Controller.Hardware RouteObject +Controller.Standard RouteObject leapmotion.json vive.json +findAction +Entities.mousePressOnEntity +Entities.mouseDoublePressOnEntity KeyEvent +Controller.Hardware.Keyboard +Controller.Hardware.Keyboard +Controller.Hardware.Touchscreen +Controller.Hardware.TouchscreenVirtualPad +Controller.Hardware.Keyboard +Controller.Actions +Controller.Actions +Controller.Actions +Controller.Actions +Controller.Actions Controller +Controller.Actions +Controller.Actions +Controller.Standard +Controller.Hardware +Controller.Hardware +Controller.Hardware Controller +Controller.Hardware +Controller.Hardware Pose +Controller.Standard +Controller.Hardware Pose Pose Pose Rect Rect +Controller.Standard +Controller.Standard Controller +Controller.Standard +Controller.Standard +Controller.Standard +Controller.Hardware Vec2 Vec2 +Controller.Standard KeyEvent KeyEvent MappingObject +MappingJSON +enableMapping +MappingJSON MappingObject MouseEvent MouseEvent @@ -97,14 +215,47 @@ Controller: MappingObject MappingObject RouteObject +enableMapping +Uuid.generate MappingObject MappingObject +MappingJSON +enableMapping +MappingJSON MappingObject +captureActionEvents +Entities.mousePressOnEntity +Entities.mouseDoublePressOnEntity +captureEntityClickEvents +captureJoystick +captureKeyEvents KeyEvent Controller.Hardware.Keyboard +captureMouseEvents +Controller.Hardware.Keyboard +Controller.Hardware.Touchscreen +Controller.Hardware.TouchscreenVirtualPad +captureTouchEvents +Controller.Hardware.Keyboard +captureWheelEvents +startInputRecording +stopInputRecording +loadInputRecording +getInputRecorderSaveDirectory +setVPadHidden +startInputRecording +stopInputRecording +loadInputRecording +stopInputPlayback +startInputPlayback +startInputRecording TouchEvent TouchEvent TouchEvent +Controller.Hand +Controller.Hand +Controller.Hand +Controller.Hand WheelEvent MappingObject Pose @@ -176,12 +327,16 @@ Controller: Pose Pose RouteObject +Controller.Standard +MappingJSON https://github.com/highfidelity/hifi/tree/master/interface/resources/controllers +Controller.Actions Controller.Hardware-Application Controller.Hardware-Keyboard Controller.Hardware-OculusTouch Controller.Hardware-Vive RouteObject +RouteObject#when RouteObject RouteObject Pose @@ -213,7 +368,21 @@ Controller: Pose MappingObject https://github.com/highfidelity/hifi/tree/master/interface/resources/controllers +Controller.MappingJSONRoute +Controller.MappingJSONRoute +Controller.Hardware +Controller.MappingJSONRoute RouteObject +Controller.MappingJSON +Controller.MappingJSONAxis +Controller.Hardware +RouteObject#peek +RouteObject#debug +Controller.Hardware +Controller.MappingJSONFilter +Controller.MappingJSONFilter +Controller.Actions +Controller.Standard RouteObject Pose leapmotion.json @@ -295,20 +464,27 @@ DebugDraw: Vec4 Entities: Uuid +Web Uuid.NULL Vec3 Vec3 Vec3 Vec3 Uuid +Entities.ActionType +Uuid +Entities.ActionArguments Uuid Uuid -Uuid +Entities.EntityProperties Uuid.NULL Uuid Uuid +Line Uuid +Line Vec3 +Line Uuid Uuid Uuid @@ -326,8 +502,11 @@ Entities: Uuid Uuid Uuid +Entities.EntityProperties Uuid +Web Uuid +Web Uuid Uuid Vec3 @@ -339,6 +518,7 @@ Entities: Vec3 Uuid Uuid +Entities.EntityType Vec3 Uuid Uuid @@ -348,22 +528,40 @@ Entities: Uuid ViewFrustum Uuid +Entities.RayToEntityIntersectionResult PickRay +setLightsArePickable +setZonesArePickable PickRay Uuid Uuid +visible +collisionless +Entities.RayToEntityIntersectionResult PickRay +setLightsArePickable +setZonesArePickable +findRayIntersection PickRay Uuid Uuid +findRayIntersection Quat +Model Uuid +Model Quat.IDENTITY Quat Vec3 +Model Uuid +Model Vec3.ZERO Vec3 +Entities.ActionArguments +Uuid +Uuid +Entities.ActionArguments Uuid Uuid Uuid @@ -373,24 +571,45 @@ Entities: Uuid Uuid Uuid +Zone +Zone Uuid +Entities.EntityProperties Uuid +Entities.EntityProperties Uuid +Model Uuid +Model +getJointNames +Model Uuid +Model +Model +getJointIndex Uuid +Web +Web Uuid -Uuid -Uuid +Light +findRayIntersection +findRayIntersectionBlocking Picks +Light Quat +Model Uuid +Model Quat.IDENTITY Quat Vec3 +Model Uuid +Model Vec3.ZERO Vec3 +Model +PolyVox Uuid Entities~getMeshesCallback Graphics @@ -398,7 +617,11 @@ Entities: Uuid Entities~getServerScriptStatusCallback Uuid +Zone +findRayIntersection +findRayIntersectionBlocking Picks +Zone Uuid PointerEvent Uuid @@ -411,8 +634,11 @@ Entities: Uuid Uuid Vec3 +PolyVox Uuid +PolyVox Vec3 +PolyVox Vec3.ZERO Vec3 PointerEvent @@ -431,76 +657,142 @@ Entities: Uuid Entities~queryPropertyMetadataCallback Uuid +clickDownOnEntity Uuid PointerEvent +clickReleaseOnEntity Uuid PointerEvent +holdingClickOnEntity Uuid PointerEvent +hoverEnterEntity Uuid PointerEvent +hoverLeaveEntity Uuid PointerEvent +hoverOverEntity Uuid PointerEvent +mouseMoveOnEntity Uuid PointerEvent +mousePressOnEntity Uuid PointerEvent +mouseReleaseOnEntity Uuid PointerEvent +Model Uuid Quat +Model +Model Uuid Vec3 +Model +Line Uuid +Line Vec3 +Line +PolyVox Uuid +PolyVox +Zone +Zone +Web Uuid +Web Uuid.NULL +Light +findRayIntersection +findRayIntersectionBlocking Picks +Light +Model Uuid Quat +Model +Model Uuid Quat +Model +Model +setLocalJointRotations +setLocalJointTranslations Uuid Quat Vec3 +Model +Model Uuid Vec3 +Model +Model Uuid Vec3 +Model +PolyVox Uuid +PolyVox Vec3 +PolyVox Uuid +PolyVox Vec3 Vec3 +PolyVox Uuid +PolyVox Vec3 Vec3 +PolyVox Uuid +PolyVox Vec3 +Zone +findRayIntersection +findRayIntersectionBlocking Picks +Zone Uuid Uuid +Entities.ActionArguments Uuid Vec3 +PolyVox Uuid +PolyVox Vec3 +PolyVox Vec3.ZERO Vec3 Vec3 +PolyVox Uuid +PolyVox Vec3 +PolyVox Vec3.ZERO Vec3 +Web +Shape Uuid +Web Uuid Vec3 +PolyVox Uuid +PolyVox Vec3 +PolyVox Vec3.ZERO Vec3 +ActionType +Entities.ActionType +Entities.PhysicsMotionType ActionArguments-FarGrab ActionArguments-Hold ActionArguments-Offset @@ -510,34 +802,52 @@ Entities: ActionArguments-Slider ActionArguments-ConeTwist ActionArguments-BallSocket +ActionType +ActionArguments Vec3 Uuid Vec3 +ActionType +ActionArguments Vec3 Vec3 Uuid Vec3 Vec3 +ActionType +ActionArguments Vec3 Quat Uuid +ActionType +ActionArguments Vec3 Vec3 Uuid Vec3 Vec3 +ActionType +ActionArguments Uuid Vec3 Vec3 +ActionType +ActionArguments Vec3 +ActionType +ActionArguments Vec3 Vec3 Uuid Vec3 Vec3 +ActionType +ActionArguments Vec3 Quat Uuid +ActionType +ActionArguments Vec3 Entities.ActionArguments-FarGrab Entities.ActionArguments-Hold @@ -548,14 +858,21 @@ Entities: ActionArguments-Slider Entities.ActionArguments-ConeTwist Entities.ActionArguments-BallSocket +Skybox Vec3 Vec3 Vec3 Vec3 +EntityType Uuid +Entities.EntityType +Entities.addEntity Uuid Uuid.NULL Uuid +Model +Shape +Zone keyLight Vec3 Quat @@ -574,6 +891,7 @@ Entities: Vec3.ZERO Vec3 Vec3.ZERO +Entities.CollisionMask SoundCache Uuid Uuid.NULL @@ -582,7 +900,9 @@ Entities: Vec3 Vec3 Vec3 +Entities.BoundingBox AACube +Entities.RenderInfo EntityProperties-Box EntityProperties-Light EntityProperties-Line @@ -596,22 +916,46 @@ Entities: EntityProperties-Text EntityProperties-Web EntityProperties-Zone +EntityType +EntityType +EntityType +EntityProperties Vec3 Color +EntityType +EntityProperties Vec3 Vec3 Color +EntityType +Model +Shape +model overlays +EntityProperties +Entities.addEntity MaterialResource MaterialResource MaterialResource Vec2 Vec2 MaterialResource +EntityType +EntityProperties Vec3 +naturalDimensions Color ShapeType +Entities.AnimationProperties Quat +getJointIndex +setLocalJointRotation +getJointIndex Vec3 +getJointIndex +setLocalJointTranslation +getJointIndex +EntityType +EntityProperties Vec3 Quat Color @@ -619,15 +963,20 @@ Entities: Color Color ShapeType +EntityType +EntityProperties Vec3 Vec3 Vec3 Vec3 Color +EntityType +EntityProperties Volumes of Fun library documentation Vec3 Vec3 +Entities.PolyVoxSurfaceStyle Uuid Uuid.NULL Uuid @@ -640,17 +989,34 @@ Entities: Uuid.NULL Uuid Uuid.NULL +EntityType +EntityProperties +Entities.Shape Vec3 Color +EntityType +EntityType +EntityType +EntityProperties Vec3 Color Color +EntityType +EntityProperties Vec3 +EntityType +Entities.enterEntity +EntityProperties Vec3 ShapeType +Entities.KeyLight +Entities.AmbientLight +Entities.Skybox +Entities.Haze EntityProperties-Box EntityProperties-Light EntityProperties-Line +model overlays EntityProperties-Material EntityProperties-Model EntityProperties-ParticleEffect @@ -665,17 +1031,27 @@ Entities: Color Color Vec3 +Model +Shape +canCastShadows PickRay +findRayIntersection +findRayIntersectionBlocking PickRay Uuid PickRay Vec3 Vec3 BoxFace +EntityType Color +Entities.getMeshes MeshProxy MeshProxy +Entities.getMeshes Graphics +Entities.getServerScriptStatus +Entities.queryPropertyMetadata Global: ContactEventType Uuid @@ -684,6 +1060,7 @@ Global: Vec3 Vec3 http://doc.qt.io/qt-5/qt#Key-enum +Material Vec3Color RGBS Vec3Color @@ -692,6 +1069,7 @@ Global: RGBS Vec3Color RGBS +Material Material Material Vec3 @@ -715,12 +1093,20 @@ Global: Vec3 Quat Graphics: - Vec3 + Graphics.Model +Graphics.Model +Graphics.Mesh +Graphics.IFSData +Graphics.Mesh +Vec3 Vec3 Vec3 Vec2 Material +Graphics.MeshPart Uuid +Graphics.Mesh +Graphics.MaterialLayer HMD: Vec3 Vec3.ZERO @@ -741,6 +1127,10 @@ HMD: Vec2 Vec2 Vec2 +requestShowHandControllers +requestHideHandControllers +requestShowHandControllers +requestHideHandControllers Vec2 Vec2 Vec2 @@ -751,6 +1141,10 @@ location: Uuid Uuid.NULL Uuid +goBack +goForward +location.LookupTrigger +location.LookupTrigger Vec3 Quat Quat.IDENTITY @@ -758,43 +1152,85 @@ location: Uuid Uuid Settings +goBack +goForward MappingObject: Controller +Controller.Standard +Controller.Actions +Controller.Hardware +Controller.Standard +Controller.Actions +Controller.newMapping +from +makeAxis RouteObject +Controller.parseMapping +Controller.loadMapping +Controller.MappingJSON +enable +Controller.enableMapping +RouteObject#peek +MappingObject +Controller.disableMapping MappingObject MappingObject -MappingObject +Controller.enableMapping MappingObject RouteObject RouteObject +Controller.Standard +Controller.Hardware Pose RouteObject RouteObject RouteObject RouteObject +from +Controller.Standard +Controller.Hardware Pose RouteObject RouteObject RouteObject RouteObject +Controller.Hardware +Controller.Hardware +Controller.Hardware RouteObject RouteObject RouteObject RouteObject +Controller.Hardware +makeAxis +Controller.Hardware +Controller.Hardware RouteObject RouteObject Menu: - KeyEvent + Menu.MenuItemProperties +Menu.MenuItemProperties +Menu.addMenuItem +Menu.MenuItemProperties +Menu.triggerOption +Menu.addMenuItem +KeyEvent KeyEvent MeshProxy: - Graphics + Entities.getMeshes +Graphics Graphics Vec3 Graphics Vec3 Messages: - Uuid + Entities.callEntityClientMethod +Entities.callEntityMethod +Entities.callEntityServerMethod +Script.callEntityScriptMethod Uuid +Uuid +sendMessage ModelCache: Resource Resource @@ -828,6 +1264,7 @@ MyAvatar: Uuid Vec3 Entities +MyAvatar.getJointNames Vec3 Quat Uuid @@ -842,6 +1279,8 @@ MyAvatar: Vec3 Vec3 Vec3 +MyAvatar.AttachmentData +MyAvatar.AttachmentData Vec3 Vec3 Quat @@ -852,6 +1291,7 @@ MyAvatar: Vec3 Vec3 Vec3 +MyAvatar.getJointNames Vec3 Vec3 Vec3 @@ -863,6 +1303,7 @@ MyAvatar: Avatar Standards Quat Quat +MyAvatar.getJointNames Quat Vec3 Avatar Standards @@ -906,6 +1347,8 @@ MyAvatar: Vec3 Vec3 Vec3 +MyAvatar.SkeletonJoint +MyAvatar.SkeletonJoint Vec3 Vec3 Vec3 @@ -923,13 +1366,17 @@ MyAvatar: Quat Quat Quat +MyAvatar.restoreAnimation Avatar Standards +MyAvatar.restoreRoleAnimation Avatar Standards Vec3 Quat Vec3 Quat Vec3 +MyAvatar.getAttachmentData +MyAvatar.AttachmentData Quat Vec3 Quat @@ -937,6 +1384,7 @@ MyAvatar: Quat Quat Quat +MyAvatar.getJointNames Vec3 Vec3 Vec3 @@ -960,8 +1408,11 @@ MyAvatar: Vec3 Overlays: Uuid +web3d Uuid.NULL Uuid +Overlays.OverlayType +Overlays.OverlayProperties Uuid.NULL Uuid Uuid @@ -970,40 +1421,60 @@ Overlays: Uuid Uuid Uuid +Overlays.OverlayProperties Uuid +Overlays.OverlayProperties +OverlayProperties Uuid Vec3 Uuid +Overlays.RayToOverlayIntersectionResult PickRay PickRay Uuid Uuid +Overlays.RayToOverlayIntersectionResult Uuid +web3d Uuid Uuid Vec2 Uuid Uuid Uuid +Overlays.OverlayProperties Uuid +OverlayProperties Uuid +Overlays.OverlayProperties +Overlays.OverlayType Uuid +Overlays.OverlayType +Overlays.OverlayProperties Uuid +Overlays.OverlayProperties Uuid +OverlayType +sendHoverEnterOverlay Uuid PointerEvent +sendHoverLeaveOverlay Uuid PointerEvent +sendHoverOverOverlay Uuid PointerEvent Uuid Uuid Uuid PointerEvent +sendMouseMoveOnOverlay Uuid PointerEvent +sendMousePressOnOverlay Uuid PointerEvent +sendMouseReleaseOnOverlay Uuid PointerEvent Uuid @@ -1020,14 +1491,17 @@ Overlays: Uuid PointerEvent Uuid +web3d Uuid.NULL Size Uuid Size +OverlayType Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 Color @@ -1041,47 +1515,58 @@ Overlays: Color Color Color +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec3 +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 Rect +OverlayType Rect Vec2 Color +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Uuid Vec3 Vec3 Vec3 Vec3 +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec3 Vec3 @@ -1089,57 +1574,107 @@ Overlays: Vec3 Quat Vec3 +OverlayType +Circle3DProperties +CubeProperties +GridProperties +ImageProperties +Image3DProperties +Line3DProperties +ModelProperties +RectangleProperties +Rectangle3DProperties +ShapeProperties +SphereProperties +TextProperties +Text3DProperties +Web3DProperties +OverlayProperties PickRay +findRayIntersection PickRay Uuid PickRay Vec3 Vec3 +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 +OverlayType Rect Color Color +OverlayType +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec3 +Overlays.Shape +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec3 +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 Color +OverlayType Rect Color Color +OverlayType Color Vec3 Vec3 Quat Quat +findRayIntersection Uuid Vec2 +Paths: + Script.resolvePath +Script.resourcesPath Picks: - Uuid + Picks.PickType +Picks.PickProperties +Picks.createPick +Picks.createPick +Picks.createPick +Picks.RayPickResult +Picks.StylusPickResult +Picks.createPick +Picks.createPick +Picks.createPick +Picks.createPick +Picks.createPick Uuid +Picks.createPick +Uuid +Picks.createPick +Picks.createPick +Picks.PickType Vec3 Vec3 Vec3 @@ -1153,13 +1688,44 @@ Picks: Vec3 StylusTip Pointers: - Uuid + Picks.PickType +Pointers.PointerProperties +Picks.PickProperties +Pointers.createPointer +Pointers.createPointer +Pointers.RayPointerRenderState +Pointers.createPointer +Pointers.createPointer +Picks.RayPickResult +Picks.StylusPickResult +Pointers.createPointer +Pointers.createPointer +Pointers.createPointer +Pointers.createPointer +Pointers.createPointer Uuid +Pointers.createPointer +Uuid +Pointers.createPointer +Pointers.createPointer +Pointers.createPointer +Pointers.RayPointerRenderState +Pointers.createPointer +Pointers.RayPointerRenderState +Pointers.createPointer +Picks.PickProperties +Pointers.RayPointerRenderState +Pointers.DefaultRayPointerRenderState +Pointers.Trigger +Pointers.setRenderState +Pointers.editRenderState Quat: Quat Quat -Quat -Vec3 +Quat.angleAxis +Quat +Vec3 +Quat.angle Quat Vec3 Quat @@ -1171,10 +1737,12 @@ Quat: Quat Quat Quat +Quat.inverse Quat Quat Quat Quat +Quat.dot Quat Quat Quat @@ -1190,9 +1758,11 @@ Quat: Vec3 Quat Vec3 +Quat.getFront Quat Vec3 Vec3 +Quat.getForward Quat Vec3 Vec3 @@ -1202,6 +1772,7 @@ Quat: Quat Vec3 Quat +Quat.conjugate Quat Quat Quat @@ -1214,6 +1785,7 @@ Quat: Vec3 Quat Quat +Quat.slerp Quat Quat Quat @@ -1234,6 +1806,7 @@ Quat: Vec3 Vec3 Quat +Quat.mix Quat Quat Quat @@ -1245,6 +1818,10 @@ Quat: Quat Recording: Recording~loadRecordingCallback +Recording.loadRecording +Resource: + Resource.State +Resource.State Reticle: Vec2 Vec2 @@ -1257,6 +1834,7 @@ RouteObject: MappingObject Controller MappingObject +RouteObject#to Pose RouteObject RouteObject @@ -1295,6 +1873,10 @@ RouteObject: RouteObject Pose RouteObject +Controller.Standard +Controller.Actions +Controller.Standard +Controller.Actions RouteObject Pose RouteObject @@ -1303,8 +1885,12 @@ RouteObject: Vec3 RouteObject RouteObject +Controller.Hardware +Controller.Hardware RouteObject RouteObject +Controller.Hardware +Controller.Hardware RouteObject Scene: Scene.Stage @@ -1325,12 +1911,16 @@ Script: PointerEvent Uuid Uuid +setInterval +setTimeout Uuid Uuid Uuid Uuid Uuid Uuid +Script.clearInterval +Script.clearTimeout Uuid ScriptDiscoveryService: ScriptsModel @@ -1342,7 +1932,16 @@ ScriptsModelFilter: ScriptDiscoveryService http://doc.qt.io/qt-5/qsortfilterproxymodel Selection: - Uuid + Selection.ItemType +Uuid +Selection.disableListToScene +Selection.enableListToScene +Selection.HighlightStyle +Selection.HighlightStyle +Selection.HighlightStyle +Selection.SelectedItemsList +Selection.SelectedItemsList +Selection.ItemType Uuid Color Color @@ -1359,10 +1958,16 @@ SoundCache: Tablet: TabletProxy TabletProxy +Tablet.AudioEvents TabletButtonProxy: Uuid +TabletButtonProxy.ButtonProperties +TabletButtonProxy.ButtonProperties +TabletButtonProxy.ButtonProperties +TabletButtonProxy.ButtonProperties TabletProxy: - TabletButtonProxy + TabletProxy#ButtonList +TabletButtonProxy TabletButtonProxy TabletButtonProxy TextureCache: @@ -1423,6 +2028,7 @@ Vec3: Vec3 Vec3 Vec3 +withinEpsilon Vec3 Vec3 Vec3 @@ -1473,12 +2079,54 @@ Vec3: Vec3 Vec3 Vec3 +equal Vec3 Vec3 Window: location +displayAnnouncement +browseAssetsAsync +assetsDirChanged +browseChanged +browseAsync +browseDirChanged +browseDirAsync +openMessageBox +announcement +Window.ConnectionRefusedReason Rect Vec2 Vec2 Vec2 -Camera.mode \ No newline at end of file +connectionAdded +connectionError +connectionAdded +connectionError +openMessageBox +updateMessageBox +closeMessageBox +Window.MessageBoxButton +Window.MessageBoxButton +takeSnapshot +takeSnapshot +promptTextChanged +promptAsync +raise +saveFileChanged +saveAsync +Camera.setCameraEntity +Camera.mode +Window.DisplayTexture +snapshotShared +shareSnapshot +takeSnapshot +takeSecondaryCameraSnapshot +takeSnapshot +stillSnapshotTaken +processingGifStarted +processingGifCompleted +stillSnapshotTaken +openMessageBox +Window.MessageBoxButton +Window.MessageBoxButton +openMessageBox \ No newline at end of file diff --git a/tools/jsdoc/gravPrep.js b/tools/jsdoc/gravPrep.js index 0193f781ae..0e3d38da6d 100644 --- a/tools/jsdoc/gravPrep.js +++ b/tools/jsdoc/gravPrep.js @@ -115,10 +115,14 @@ function modifyClassLinks(match, p1,p2,p3,p4){ let matchedp = [p2,p3].join(""); if(!isMultipleDots(matchedp)){ - return; + console.log("not multiple"); + console.log("matchedp:", matchedp) + return match; } p2 = p2.split('.')[1].toLowerCase(); - return [p1,p2,p3,p4].join(""); + let newString = [p1,p2,p3,p4].join(""); + // console.log("new String:", newString); + return newString; } function lowerCaseGeneralLinks(match, p1, p2, p3, p4){ @@ -136,7 +140,7 @@ } if (!linksNoHashes){ return content; - } + } for(var i = linksNoHashes.length-1; i > -1; i--){ if (linksNoHashes[i][0].indexOf("http") > -1){ continue; @@ -149,7 +153,8 @@ } let group3 = linksNoHashes[i][3]; let index = linksNoHashes[i][4]; - let newString = `${group1}/api-reference/${returnRightGroup(group2)}/${group2.toLowerCase()}${group3}`; + let newString = `${group1}/api-reference/${returnRightGroup(group2)}/${group2.toLowerCase()}${group3}`; + // console.log("newString", newString); content = [content.slice(0,index), newString, content.slice(index+linkLength)].join(""); } return content; @@ -161,6 +166,8 @@ for (i = 0; i < groupNameMemberMap[key].length; i++ ){ if (methodToCheck.toLowerCase() === groupNameMemberMap[key][i].toLowerCase()){ return key.toLowerCase(); + } else { + // console.log("Couldn't find group: ", methodToCheck); } } } diff --git a/tools/jsdoc/package.json b/tools/jsdoc/package.json index f30fa707ab..4bbb2ad4f2 100644 --- a/tools/jsdoc/package.json +++ b/tools/jsdoc/package.json @@ -1,6 +1,7 @@ { "name": "hifiJSDoc", "dependencies": { + "axios": "^0.18.0", "cheerio": "^1.0.0-rc.2", "dedent-js": "^1.0.1", "htmlclean": "^3.0.8",