From 70ec84177aa808ae4a8d906f51a8ff9965ea19b0 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 14 May 2019 10:32:28 +1200 Subject: [PATCH] Doc review --- interface/src/raypick/CollisionPick.cpp | 2 +- interface/src/raypick/PickScriptingInterface.cpp | 2 +- libraries/shared/src/PhysicsCollisionGroups.h | 2 +- libraries/shared/src/RegisteredMetaTypes.h | 9 +++++---- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/interface/src/raypick/CollisionPick.cpp b/interface/src/raypick/CollisionPick.cpp index b3888ae3a0..83ed61030e 100644 --- a/interface/src/raypick/CollisionPick.cpp +++ b/interface/src/raypick/CollisionPick.cpp @@ -61,7 +61,7 @@ void buildObjectIntersectionsMap(IntersectionType intersectionType, const std::v * An intersection result for a collision pick. * * @typedef {object} CollisionPickResult - * @property {boolean} intersects - truen if there is at least one intersection, false if there isn't. + * @property {boolean} intersects - true if there is at least one intersection, false if there isn't. * @property {IntersectingObject[]} intersectingObjects - All objects which intersect with the collisionRegion. * @property {CollisionRegion} collisionRegion - The collision region that was used. Valid even if there was no intersection. */ diff --git a/interface/src/raypick/PickScriptingInterface.cpp b/interface/src/raypick/PickScriptingInterface.cpp index dff68f3ded..82d00d803f 100644 --- a/interface/src/raypick/PickScriptingInterface.cpp +++ b/interface/src/raypick/PickScriptingInterface.cpp @@ -325,7 +325,7 @@ unsigned int PickScriptingInterface::createParabolaPick(const QVariant& properti * @property {number} threshold - The approximate minimum penetration depth for a test object to be considered in contact with * the collision region. The depth is in world coordinates but scales with the parent if defined. * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision - * masks overlap with the regions's collision group are considered to be colliding with the region. + * masks overlap with the region's collision group are considered to be colliding with the region. */ unsigned int PickScriptingInterface::createCollisionPick(const QVariant& properties) { QVariantMap propMap = properties.toMap(); diff --git a/libraries/shared/src/PhysicsCollisionGroups.h b/libraries/shared/src/PhysicsCollisionGroups.h index 7323133876..08fc5f5ac0 100644 --- a/libraries/shared/src/PhysicsCollisionGroups.h +++ b/libraries/shared/src/PhysicsCollisionGroups.h @@ -72,7 +72,7 @@ const int32_t BULLET_COLLISION_MASK_DETAILED_RAY = BULLET_COLLISION_GROUP_DETAIL const int32_t BULLET_COLLISION_MASK_COLLISIONLESS = 0; /**jsdoc - *

A collision may be with the following types of items:

+ *

A collision may occur with the following types of items:

* * * diff --git a/libraries/shared/src/RegisteredMetaTypes.h b/libraries/shared/src/RegisteredMetaTypes.h index 25a1792fe2..dfd388230f 100644 --- a/libraries/shared/src/RegisteredMetaTypes.h +++ b/libraries/shared/src/RegisteredMetaTypes.h @@ -426,15 +426,16 @@ public: /**jsdoc * A volume for checking collisions in the physics simulation. * @typedef {object} CollisionRegion - * @property {Shape} shape - The collision region's shape and size. Dimensions are in world space, but scale with the parent - * if defined. - * @property {boolean} loaded - true if the shape has no model, or has a model and it is loaded. + * @property {Shape} shape - The collision region's shape and size. Dimensions are in world coordinates, but scale with the + * parent if defined. + * @property {boolean} loaded - true if the shape has no model, or has a model and it is loaded, + * false if otherwise. * @property {Vec3} position - The position of the collision region, relative to the parent if defined. * @property {Quat} orientation - The orientation of the collision region, relative to the parent if defined. * @property {number} threshold - The approximate minimum penetration depth for a test object to be considered in contact with * the collision region. The depth is in world coordinates but scales with the parent if defined. * @property {CollisionMask} [collisionGroup=8] - The type of objects the collision region collides as. Objects whose collision - * masks overlap with the regions's collision group are considered to be colliding with the region. + * masks overlap with the region's collision group are considered to be colliding with the region. */ /**jsdoc
ValueDescription