Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-09 05:03:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #15578 from ctrlaltdavid/M22520

Browse source 
Case 22520: Tidy new Window API plugin functions' JSDoc
This commit is contained in:
jennaingersoll 2019-05-17 09:59:07 -07:00 committed by GitHub
commit 14e7f185c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
interface/src/scripting/WindowScriptingInterface.h
View file

@ -559,39 +559,47 @@ public slots:
float domainLoadingProgress();
/**jsdoc
* Return the number of display plugins currently available
* Gets the number of display plugins currently available.
* @function Window.getDisplayPluginCount
* @returns {int} The number of currently available display plugins
* @returns {number} The number of display plugins currently available.
*/
int getDisplayPluginCount();
/**jsdoc
* Return the human readable name of a display plugin
* Gets the name of a display plugin.
* @function Window.getDisplayPluginName
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}.
* @returns {string} The name of the specified display plugin
* @param {number} index - The index of the display plugin. Must be less than the value returned by
* {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
* @returns {string} The name of the display plugin.
* @example <caption>Print the names of all available display plugins.</caption>
* for (var i = 0, length = Window.getDisplayPluginCount(); i < length; i++) {
* print(Window.getDisplayPluginName(i));
* }
*/
QString getDisplayPluginName(int index);
/**jsdoc
* Return whether a given display plugin is an HMD
* Checks whether a display plugin is an HMD.
* @function Window.isDisplayPluginHmd
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}.
* @returns {bool} True if the specified display plugin is a HMD
* @param {number} index - The index of the display plugin. Must be less than the value returned by
* {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
* @returns {boolean} <code>true</code> if the display plugin is a HMD, <code>false</code> if it isn't.
*/
bool isDisplayPluginHmd(int index);
/**jsdoc
* Return the currently active display plugin
* Gets the index of the currently active display plugin.
* @function Window.getActiveDisplayPlugin
* @returns {int} The index of the currently active display plugin
* @returns {number} The index of the currently active display plugin. The first display plugin has an index of
* <code>0</code>.
*/
int getActiveDisplayPlugin();
/**jsdoc
* Return the currently active display plugin
* Sets the currently active display plugin.
* @function Window.setActiveDisplayPlugin
* @param {int} index - The index of the display plugin. Must be less than the value returned by {@link Window.getDisplayPluginCount|getDisplayPluginCount}.
* @param {number} index - The index of the display plugin. Must be less than the value returned by
* {@link Window.getDisplayPluginCount|getDisplayPluginCount}. The first display plugin has an index of <code>0</code>.
*/
void setActiveDisplayPlugin(int index);

2
libraries/networking/src/MessagesClient.h
View file

@ -147,7 +147,7 @@ public:
/**jsdoc
* Subscribes the scripting environment &mdash; Interface, the entity script server, or assignment client instance &mdash;
* to receive messages on a specific channel.This means, for example, that if there are two Interface scripts that
* to receive messages on a specific channel. This means, for example, that if there are two Interface scripts that
* subscribe to different channels, both scripts will receive messages on both channels.
* @function Messages.subscribe
* @param {string} channel - The channel to subscribe to.