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.h (1 of 4 files). Show all

Unified · Split

interface/src/scripting/DesktopScriptingInterface.h+3−3
@@ -42,8 +42,8 @@ · 41 unmodified lines
42 * @property {InteractiveWindow.DockAreas} DockArea - The possible docking locations of an {@link InteractiveWindow}: top, 42 * @property {InteractiveWindow.DockAreas} DockArea - The possible docking locations of an {@link InteractiveWindow}: top,
43 * bottom, left, or right of the Interface window. 43 * bottom, left, or right of the Interface window.
44 * <em>Read-only.</em>44 * <em>Read-only.</em>
45 * @property {InteractiveWindow.RelativePositionAnchors} RelativePositionAnchor - The possible "relative position anchors" for an {@link InteractiveWindow}: top left, 45 * @property {InteractiveWindow.RelativePositionAnchors} RelativePositionAnchor - The possible relative position anchors for an
46 * top right, bottom right, or bottom left of the Interface window. 46 * {@link InteractiveWindow}: none, top left, top right, bottom right, or bottom left of the Interface window.
47 * <em>Read-only.</em>47 * <em>Read-only.</em>
48 */48 */
49class DesktopScriptingInterface : public QObject, public Dependency {49class DesktopScriptingInterface : public QObject, public Dependency {
@@ -84,7 +84,7 @@ public: · 34 unmodified lines
84 * @param {string} url - The QML file that specifies the window content. The QML file can use a <code>WebView</code> 84 * @param {string} url - The QML file that specifies the window content. The QML file can use a <code>WebView</code>
85 * control (defined by "WebView.qml" included in the Interface install) to embed an HTML web page (complete with 85 * control (defined by "WebView.qml" included in the Interface install) to embed an HTML web page (complete with
86 * <code>EventBridge</code> object).86 * <code>EventBridge</code> object).
87 * @param {InteractiveWindow.Properties} [properties] - Initial window properties.87 * @param {InteractiveWindow.WindowProperties} [properties] - Initial window properties.
88 * @returns {InteractiveWindow} A new window object.88 * @returns {InteractiveWindow} A new window object.
89 * @example <caption>Open a dialog in its own window separate from Interface.</caption>89 * @example <caption>Open a dialog in its own window separate from Interface.</caption>
90 * var nativeWindow = Desktop.createWindow(Script.resourcesPath() + 'qml/OverlayWindowTest.qml', {90 * var nativeWindow = Desktop.createWindow(Script.resourcesPath() + 'qml/OverlayWindowTest.qml', {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t