From 7e2bb0e5ed028e664d5cb709032016a99fba7933 Mon Sep 17 00:00:00 2001 From: Ryan Huffman Date: Mon, 14 Nov 2016 13:51:51 -0800 Subject: [PATCH] Cleanup camera docs --- interface/src/Camera.h | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/interface/src/Camera.h b/interface/src/Camera.h index 27904242ab..cedfb3f185 100644 --- a/interface/src/Camera.h +++ b/interface/src/Camera.h @@ -35,9 +35,6 @@ __attribute__((unused)) #endif static int cameraModeId = qRegisterMetaType(); -/**jsdoc - * @global - */ class Camera : public QObject { Q_OBJECT @@ -96,9 +93,9 @@ public slots: /**jsdoc * Compute a {PickRay} based on the current camera configuration and the position x,y on the screen. * @function Camera.computePickRay - * @param {float} x - * @param {float} y - * @return {PickRay} + * @param {float} x X-coordinate on screen. + * @param {float} y Y-coordinate on screen. + * @return {PickRay} The computed {PickRay}. */ PickRay computePickRay(float x, float y); @@ -106,7 +103,7 @@ public slots: * Set the camera to look at position position. Only works while in independent. * camera mode. * @function Camera.lookAt - * @param {Vec3} position position to look at + * @param {Vec3} Position Position to look at. */ void lookAt(const glm::vec3& position); @@ -114,7 +111,7 @@ public slots: * Set the camera to continue looking at position position. * Only works while in `independent` camera mode. * @function Camera.keepLookingAt - * @param {Vec3} position position to look at + * @param {Vec3} position Position to keep looking at. */ void keepLookingAt(const glm::vec3& position);