Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-14 07:27:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Revisions and typos

Browse source
This commit is contained in:
David Rowe 2019-07-26 10:50:53 +12:00
parent bce3e9bd6b
commit 0555cf1804
2 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
interface/src/scripting/PlatformInfoScriptingInterface.h
View file

@ -32,7 +32,7 @@ public:
virtual ~PlatformInfoScriptingInterface(); virtual ~PlatformInfoScriptingInterface();
/**jsdoc /**jsdoc
* <p>The platform tier of a computer is an indication of its graphics capability.</p> * <p>The platform tier of a computer is an indication of its rendering capability.</p>
* <table> * <table>
* <thead> * <thead>
* <tr><th>Value</th><th>Name</th><th>Description</th></tr> * <tr><th>Value</th><th>Name</th><th>Description</th></tr>
@ -139,23 +139,23 @@ public slots:
bool isStandalone(); bool isStandalone();
/**jsdoc /**jsdoc
* Gets the number of CPUs in the hardware platform. * Gets the number of CPUs.
* @function PlatformInfo.getNumCPUs * @function PlatformInfo.getNumCPUs
* @returns {number} The number of CPUs in the hardware platform. * @returns {number} The number of CPUs.
*/ */
int getNumCPUs(); int getNumCPUs();
/**jsdoc /**jsdoc
* Gets the index number of the master CPU. * Gets the index number of the master CPU.
* @function PlatformInfo.getMasterCPU * @function PlatformInfo.getMasterCPU
* @returns {number} The index of the master CPU in the hardware platform. * @returns {number} The index of the master CPU.
*/ */
int getMasterCPU(); int getMasterCPU();
/**jsdoc /**jsdoc
* Gets the platform description of a CPU. * Gets the platform description of a CPU.
* @function PlatformInfo.getCPU * @function PlatformInfo.getCPU
* @param {number} index - The index number of the CPU in the hardware platform. * @param {number} index - The index number of the CPU.
* @returns {string} The CPU's {@link PlatformInfo.CPUDescription|CPUDescription} information as a JSON string. * @returns {string} The CPU's {@link PlatformInfo.CPUDescription|CPUDescription} information as a JSON string.
* @example <caption>Report details of the computer's CPUs.</caption> * @example <caption>Report details of the computer's CPUs.</caption>
* var numCPUs = PlatformInfo.getNumCPUs(); * var numCPUs = PlatformInfo.getNumCPUs();
@ -168,22 +168,22 @@ public slots:
QString getCPU(int index); QString getCPU(int index);
/**jsdoc /**jsdoc
* Gets the number of GPUs in the hardware platform. * Gets the number of GPUs.
* @function PlatformInfo.getNumGPUs * @function PlatformInfo.getNumGPUs
* @returns {number} The number of GPUs in the hardware platform. * @returns {number} The number of GPUs.
*/ */
int getNumGPUs(); int getNumGPUs();
/**jsdoc /**jsdoc
* Gets the index number of the master GPU. * Gets the index number of the master GPU.
* @function PlatformInfo.getMasterGPU * @function PlatformInfo.getMasterGPU
* @returns {number} The index of the master GPU detected in the hardware platform. * @returns {number} The index of the master GPU.
*/ */
int getMasterGPU(); int getMasterGPU();
/**jsdoc /**jsdoc
* Gets the platform description of a GPU. * Gets the platform description of a GPU.
* @param {number} index - The index number of the GPU in the hardware platform. * @param {number} index - The index number of the GPU.
* @function PlatformInfo.getGPU * @function PlatformInfo.getGPU
* @returns {string} The GPU's {@link PlatformInfo.GPUDescription|GPUDescription} information as a JSON string. * @returns {string} The GPU's {@link PlatformInfo.GPUDescription|GPUDescription} information as a JSON string.
* @example <caption>Report details of the computer's GPUs.</caption> * @example <caption>Report details of the computer's GPUs.</caption>
@ -197,22 +197,22 @@ public slots:
QString getGPU(int index); QString getGPU(int index);
/**jsdoc /**jsdoc
* Gets the number of displays in the hardware platform. * Gets the number of displays.
* @function PlatformInfo.getNumDisplays * @function PlatformInfo.getNumDisplays
* @returns {number} The number of displays in the hardware platform. * @returns {number} The number of displays.
*/ */
int getNumDisplays(); int getNumDisplays();
/**jsdoc /**jsdoc
* Gets the index number of the master display. * Gets the index number of the master display.
* @function PlatformInfo.getMasterDisplay * @function PlatformInfo.getMasterDisplay
* @returns {number} The index of the master display in the hardware platform. * @returns {number} The index of the master display.
*/ */
int getMasterDisplay(); int getMasterDisplay();
/**jsdoc /**jsdoc
* Gets the platform description of a display. * Gets the platform description of a display.
* @param {number} index - The index number of the display in the hardware platform. * @param {number} index - The index number of the display.
* @function PlatformInfo.getDisplay * @function PlatformInfo.getDisplay
* @returns {string} The display's {@link PlatformInfo.DisplayDescription|DisplayDescription} information as a JSON string. * @returns {string} The display's {@link PlatformInfo.DisplayDescription|DisplayDescription} information as a JSON string.
* @example <caption>Report details of the systems's displays.</caption> * @example <caption>Report details of the systems's displays.</caption>
@ -242,7 +242,7 @@ public slots:
QString getComputer(); QString getComputer();
/**jsdoc /**jsdoc
* Gets the complete description of the hardware platform. * Gets the complete description of the computer as a whole.
* @function PlatformInfo.getPlatform * @function PlatformInfo.getPlatform
* @returns {string} The {@link PlatformInfo.PlatformDescription|PlatformDescription} information as a JSON string. * @returns {string} The {@link PlatformInfo.PlatformDescription|PlatformDescription} information as a JSON string.
*/ */

4
libraries/platform/src/platform/backend/Platform.cpp
View file

@ -11,7 +11,7 @@
#include "../PlatformKeys.h" #include "../PlatformKeys.h"
/**jsdoc /**jsdoc
* Information on the hardware platform. * Information on the computer platform as a whole.
* @typedef {object} PlatformInfo.PlatformDescription * @typedef {object} PlatformInfo.PlatformDescription
* @property {PlatformInfo.ComputerDescription} computer - Information on the computer. * @property {PlatformInfo.ComputerDescription} computer - Information on the computer.
* @property {PlatformInfo.CPUDescription[]} cpus - Information on the computer's CPUs. * @property {PlatformInfo.CPUDescription[]} cpus - Information on the computer's CPUs.
@ -96,7 +96,7 @@ namespace platform { namespace keys {
* @property {number} modeRefreshrate - The refresh rate of the current display mode, in Hz. * @property {number} modeRefreshrate - The refresh rate of the current display mode, in Hz.
* @property {number} modeWidth - The width of the current display mode, in pixels. * @property {number} modeWidth - The width of the current display mode, in pixels.
* @property {number} modeHeight - The height of the current display mode, in pixels. * @property {number} modeHeight - The height of the current display mode, in pixels.
* @property {boolean} isMaster - <code>true</code> if the GPU is the "master" or primary GPU, <code>false</code> or * @property {boolean} isMaster - <code>true</code> if the GPU is the "master" or primary display, <code>false</code> or
* <code>undefined</code> if it isn't. * <code>undefined</code> if it isn't.
*/ */
namespace display { namespace display {