Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-08-09 17:50:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tablet JSDoc fixes

Browse source
This commit is contained in:
David Rowe 2019-10-12 11:42:49 +13:00
parent 94f9e35704
commit d4c5a20c4f
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
libraries/ui/src/ui/TabletScriptingInterface.h
View file

@ -39,9 +39,10 @@ class QmlWindowClass;
class OffscreenQmlSurface; class OffscreenQmlSurface;
/**jsdoc /**jsdoc
* The <code>Tablet</code> API provides the facilities to work with the system or other tablet. In toolbar mode (Developer &gt; * The <code>Tablet</code> API provides the facilities to work with the system or other tablet. In toolbar mode (see Developer
* UI &gt; Tablet Becomes Toolbar), the tablet's menu buttons are displayed in a toolbar and other tablet content is displayed * &gt; UI options), the tablet's menu buttons are displayed in a toolbar and other tablet content is displayed in a dialog.
* in a dialog. *
* <p>See also the {@link Toolbars} API for working with toolbars.</p>
* *
* @namespace Tablet * @namespace Tablet
* *
@ -98,7 +99,7 @@ public:
void setToolbarScriptingInterface(ToolbarScriptingInterface* toolbarScriptingInterface) { _toolbarScriptingInterface = toolbarScriptingInterface; } void setToolbarScriptingInterface(ToolbarScriptingInterface* toolbarScriptingInterface) { _toolbarScriptingInterface = toolbarScriptingInterface; }
/**jsdoc /**jsdoc
* Gets an instance of a tablet. A new tablet is created if one with the specified ID doesn't already exist. * Gets an instance of a tablet. A new tablet is created if one with the specified name doesn't already exist.
* @function Tablet.getTablet * @function Tablet.getTablet
* @param {string} name - A unique name that identifies the tablet. * @param {string} name - A unique name that identifies the tablet.
* @returns {TabletProxy} The tablet instance. * @returns {TabletProxy} The tablet instance.
@ -210,11 +211,10 @@ private:
Q_DECLARE_METATYPE(TabletButtonsProxyModel*); Q_DECLARE_METATYPE(TabletButtonsProxyModel*);
/**jsdoc /**jsdoc
* An instance of a tablet. In toolbar mode (Developer &gt; * An instance of a tablet. In toolbar mode (see Developer &gt; UI options), the tablet's menu buttons are displayed in a
* UI &gt; Tablet Becomes Toolbar), the tablet's menu buttons are displayed in a toolbar and other tablet content is displayed * toolbar and other tablet content is displayed in a dialog.
* in a dialog.
* *
* <p>Create a new tablet or retrieve an existing tablet using {@link Tablet.getTablet}.</p> * <p>Retrieve an existing tablet or create a new tablet using {@link Tablet.getTablet}.</p>
* *
* @class TabletProxy * @class TabletProxy
* *
@ -317,7 +317,7 @@ public:
Q_INVOKABLE void returnToPreviousAppImpl(bool localSafeContext); Q_INVOKABLE void returnToPreviousAppImpl(bool localSafeContext);
/**jsdoc /**jsdoc
*@function TabletProxy#loadQMLOnTopImpl * @function TabletProxy#loadQMLOnTopImpl
* @deprecated This function is deprecated and will be removed. * @deprecated This function is deprecated and will be removed.
*/ */
// Internal function, do not call from scripts. // Internal function, do not call from scripts.