From 179eed5d1140114738381df9ac0259e758f50cf8 Mon Sep 17 00:00:00 2001 From: Ryan Huffman Date: Wed, 16 Nov 2016 11:56:42 -0800 Subject: [PATCH] Add Vec2 and Vec3 defiitions to jsdoc --- libraries/script-engine/src/Vec3.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/libraries/script-engine/src/Vec3.h b/libraries/script-engine/src/Vec3.h index 71b6cf3872..07f2279d02 100644 --- a/libraries/script-engine/src/Vec3.h +++ b/libraries/script-engine/src/Vec3.h @@ -20,6 +20,24 @@ #include "GLMHelpers.h" +/**jsdoc + * A 2-dimensional vector. + * + * @typedef Vec2 + * @property {float} x X-coordinate of the vector. + * @property {float} y Y-coordinate of the vector. + */ + +/**jsdoc + * A 3-dimensional vector. + * + * @typedef Vec3 + * @property {float} x X-coordinate of the vector. + * @property {float} y Y-coordinate of the vector. + * @property {float} z Z-coordinate of the vector. + */ + + /// Scriptable interface a Vec3ernion helper class object. Used exclusively in the JavaScript API class Vec3 : public QObject { Q_OBJECT