History

Fix up InteractiveWindow JSDoc per recent changes

David Rowe committed 6 years ago

Commit c52fa7a1 parent ccc4be54 files · +97 −48Browse files

Showing the changes to interface/src/scripting/DesktopScriptingInterface.cpp (1 of 4 files). Show all

Unified · Split

interface/src/scripting/DesktopScriptingInterface.cpp+10−36
@@ -30,21 +30,6 @@ · 29 unmodified lines
3030 * @property {InteractiveWindow.DockArea} LEFT - Dock to the left edge of the Interface window.
3131 * @property {InteractiveWindow.DockArea} RIGHT - Dock to the right edge of the Interface window.
3232 */
33−/**jsdoc
34− * <p>A docking location of an <code>InteractiveWindow</code>.</p>
35− * <table>
36− * <thead>
37− * <tr><th>Value</th><th>Name</th><th>Description</th></tr>
38− * </thead>
39− * <tbody>
40− * <tr><td><code>0</code></td><td>TOP</td><td>Dock to the top edge of the Interface window.</td></tr>
41− * <tr><td><code>1</code></td><td>BOTTOM</td><td>Dock to the bottom edge of the Interface window.</td></tr>
42− * <tr><td><code>2</code></td><td>LEFT</td><td>Dock to the left edge of the Interface window.</td></tr>
43− * <tr><td><code>3</code></td><td>RIGHT</td><td>Dock to the right edge of the Interface window.</td></tr>
44− * <tbody>
45− * </table>
46− * @typedef {number} InteractiveWindow.DockArea
47− */
4833 static const QVariantMap DOCK_AREA {
4934 { "TOP", DockArea::TOP },
5035 { "BOTTOM", DockArea::BOTTOM },
@@ -53,13 +38,17 @@ static const QVariantMap DOCK_AREA { · 2 unmodified lines
5338 };
5439
5540 /**jsdoc
56− * The possible "relative position anchors" of an <code>InteractiveWindow</code>. Used when defining the `relativePosition` property of an `InteractiveWindow`.
41+ * The possible relative position anchors of an <code>InteractiveWindow</code> relative to the Interface window.
5742 * @typedef {object} InteractiveWindow.RelativePositionAnchors
58− * @property {InteractiveWindow.RelativePositionAnchor} NO_ANCHOR - Specifies that the position of the `InteractiveWindow` will not be relative to any part of the Interface window.
59− * @property {InteractiveWindow.RelativePositionAnchor} TOP_LEFT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the top left of the Interface window.
60− * @property {InteractiveWindow.RelativePositionAnchor} TOP_RIGHT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the top right of the Interface window.
61− * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_RIGHT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the bottom right of the Interface window.
62− * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_LEFT - Specifies that the `relativePosition` of the `InteractiveWindow` will be offset from the bottom left of the Interface window.
43+ * @property {InteractiveWindow.RelativePositionAnchor} NO_ANCHOR - Position is not relative to any part of the Interface
44+ * window.
45+ * @property {InteractiveWindow.RelativePositionAnchor} TOP_LEFT - Position is offset from the top left of the Interface window.
46+ * @property {InteractiveWindow.RelativePositionAnchor} TOP_RIGHT - Position is offset from the top right of the Interface
47+ * window.
48+ * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_RIGHT - Position offset from the bottom right of the Interface
49+ * window.
50+ * @property {InteractiveWindow.RelativePositionAnchor} BOTTOM_LEFT - Position is offset from the bottom left of the Interface
51+ * window.
6352 */
6453 static const QVariantMap RELATIVE_POSITION_ANCHOR {
6554 { "NO_ANCHOR", RelativePositionAnchor::NO_ANCHOR },
@@ -89,21 +78,6 @@ int DesktopScriptingInterface::getHeight() { · 23 unmodified lines
8978 * @property {InteractiveWindow.PresentationMode} NATIVE - The window is displayed separately from the Interface window, as its
9079 * own separate window.
9180 */
92−/**jsdoc
93− * <p>A display mode for an <code>InteractiveWindow</code>.</p>
94− * <table>
95− * <thead>
96− * <tr><th>Value</th><th>Name</th><th>Description</th></tr>
97− * </thead>
98− * <tbody>
99− * <tr><td><code>0</code></td><td>VIRTUAL</td><td>The window is displayed inside Interface: in the desktop window in
100− * desktop mode or on the HUD surface in HMD mode.</td></tr>
101− * <tr><td><code>1</code></td><td>NATIVE</td><td>The window is displayed separately from the Interface window, as its
102− * own separate window.</td></tr>
103− * <tbody>
104− * </table>
105− * @typedef {number} InteractiveWindow.PresentationMode
106− */
10781 QVariantMap DesktopScriptingInterface::getPresentationMode() {
10882 static QVariantMap presentationModes {
10983 { "VIRTUAL", Virtual },