From 4bf7b629398b0e79da8efc247396facb87811b61 Mon Sep 17 00:00:00 2001 From: Antoine Vandecreme Date: Sun, 10 Apr 2016 19:01:30 -0400 Subject: [PATCH] Fix enums doc. --- src/overlay.js | 7 +++++-- src/placement.js | 2 ++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/overlay.js b/src/overlay.js index 76eb347c..25cc50d2 100644 --- a/src/overlay.js +++ b/src/overlay.js @@ -42,6 +42,7 @@ * @member OverlayPlacement * @memberof OpenSeadragon * @static + * @readonly * @type {Object} * @property {Number} CENTER * @property {Number} TOP_LEFT @@ -57,8 +58,10 @@ /** * An enumeration of possible ways to handle overlays rotation + * @member OverlayRotationMode * @memberOf OpenSeadragon * @static + * @readonly * @property {Number} NO_ROTATION The overlay ignore the viewport rotation. * @property {Number} EXACT The overlay use CSS 3 transforms to rotate with * the viewport. If the overlay contains text, it will get rotated as well. @@ -66,11 +69,11 @@ * taking the size of the bounding box of the rotated bounds. * Only valid for overlays with Rect location and scalable in both directions. */ - $.OverlayRotationMode = { + $.OverlayRotationMode = $.freezeObject({ NO_ROTATION: 1, EXACT: 2, BOUNDING_BOX: 3 - }; + }); /** * @class Overlay diff --git a/src/placement.js b/src/placement.js index a90bf5da..561d5daf 100644 --- a/src/placement.js +++ b/src/placement.js @@ -35,8 +35,10 @@ /** * An enumeration of positions to anchor an element. + * @member Placement * @memberOf OpenSeadragon * @static + * @readonly * @property {OpenSeadragon.Placement} CENTER * @property {OpenSeadragon.Placement} TOP_LEFT * @property {OpenSeadragon.Placement} TOP