From 1988ee383a0c6116e43be606ec442dd5748a7472 Mon Sep 17 00:00:00 2001 From: Matthew Petroff Date: Wed, 29 Jul 2015 21:35:44 -0400 Subject: [PATCH] Minor documentation update. --- src/js/libpannellum.js | 8 ++++---- src/js/pannellum.js | 8 +++----- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/js/libpannellum.js b/src/js/libpannellum.js index 5a9bb4b..5153cc1 100644 --- a/src/js/libpannellum.js +++ b/src/js/libpannellum.js @@ -29,10 +29,10 @@ window.libpannellum = (function(window, document, undefined) { * Creates a new panorama renderer. * @constructor * @param {HTMLElement} container - The container element for the renderer. - * @param image - Input image; format varies based on `imageType`. For - * `equirectangular`, this is an image; for `cubemap`, this is an array of - * images for the cube faces in the order [+z, +x, -z, -x, +y, -y]; for - * `multires`, this is a configuration object. + * @param {Image|Array|Object} image - Input image; format varies based on + * `imageType`. For `equirectangular`, this is an image; for `cubemap`, + * this is an array of images for the cube faces in the order [+z, +x, -z, + * -x, +y, -y]; for `multires`, this is a configuration object. * @param {string} imageType - The type of the image: `equirectangular`, * `cubemap`, or `multires`. * @param {boolean} video - Whether or not the image is a video. diff --git a/src/js/pannellum.js b/src/js/pannellum.js index 7de6831..b75fbb0 100644 --- a/src/js/pannellum.js +++ b/src/js/pannellum.js @@ -442,7 +442,7 @@ function parseGPanoXMP(image) { * Displays an error message. * @private * @param {string} error - Error message to display. If not specified, a - * generic WebGL error is displayed. + * generic WebGL error is displayed. */ function anError(error) { if (error !== undefined) { @@ -1488,10 +1488,8 @@ function load() { * Loads scene. * @private * @param {string} sceneId - Identifier of scene configuration to merge in. - * @param {number} targetPitch - Pitch viewer should be centered on once scene - * loads. - * @param {number} targetYaw - Yaw viewer should be centered on once scene - * loads. + * @param {number} targetPitch - Pitch viewer should be centered on once scene loads. + * @param {number} targetYaw - Yaw viewer should be centered on once scene loads. */ function loadScene(sceneId, targetPitch, targetYaw) { loaded = false;