diff --git a/interface/src/scripting/PlatformInfoScriptingInterface.h b/interface/src/scripting/PlatformInfoScriptingInterface.h index 8bb510832a..25cdc99577 100644 --- a/interface/src/scripting/PlatformInfoScriptingInterface.h +++ b/interface/src/scripting/PlatformInfoScriptingInterface.h @@ -32,7 +32,7 @@ public: virtual ~PlatformInfoScriptingInterface(); /**jsdoc - *

The platform tier of a computer is an indication of its graphics capability.

+ *

The platform tier of a computer is an indication of its rendering capability.

* * * @@ -139,23 +139,23 @@ public slots: bool isStandalone(); /**jsdoc - * Gets the number of CPUs in the hardware platform. + * Gets the number of CPUs. * @function PlatformInfo.getNumCPUs - * @returns {number} The number of CPUs in the hardware platform. + * @returns {number} The number of CPUs. */ int getNumCPUs(); /**jsdoc * Gets the index number of the master CPU. * @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(); /**jsdoc * Gets the platform description of a CPU. * @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. * @example * var numCPUs = PlatformInfo.getNumCPUs(); @@ -168,22 +168,22 @@ public slots: QString getCPU(int index); /**jsdoc - * Gets the number of GPUs in the hardware platform. + * Gets the number of GPUs. * @function PlatformInfo.getNumGPUs - * @returns {number} The number of GPUs in the hardware platform. + * @returns {number} The number of GPUs. */ int getNumGPUs(); /**jsdoc * Gets the index number of the master GPU. * @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(); /**jsdoc * 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 * @returns {string} The GPU's {@link PlatformInfo.GPUDescription|GPUDescription} information as a JSON string. * @example @@ -197,22 +197,22 @@ public slots: QString getGPU(int index); /**jsdoc - * Gets the number of displays in the hardware platform. + * Gets the number of displays. * @function PlatformInfo.getNumDisplays - * @returns {number} The number of displays in the hardware platform. + * @returns {number} The number of displays. */ int getNumDisplays(); /**jsdoc * Gets the index number of the master display. * @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(); /**jsdoc * 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 * @returns {string} The display's {@link PlatformInfo.DisplayDescription|DisplayDescription} information as a JSON string. * @example @@ -242,7 +242,7 @@ public slots: QString getComputer(); /**jsdoc - * Gets the complete description of the hardware platform. + * Gets the complete description of the computer as a whole. * @function PlatformInfo.getPlatform * @returns {string} The {@link PlatformInfo.PlatformDescription|PlatformDescription} information as a JSON string. */ diff --git a/libraries/platform/src/platform/backend/Platform.cpp b/libraries/platform/src/platform/backend/Platform.cpp index 89248ddefa..fad1f546ad 100644 --- a/libraries/platform/src/platform/backend/Platform.cpp +++ b/libraries/platform/src/platform/backend/Platform.cpp @@ -11,7 +11,7 @@ #include "../PlatformKeys.h" /**jsdoc - * Information on the hardware platform. + * Information on the computer platform as a whole. * @typedef {object} PlatformInfo.PlatformDescription * @property {PlatformInfo.ComputerDescription} computer - Information on the computer. * @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} modeWidth - The width of the current display mode, in pixels. * @property {number} modeHeight - The height of the current display mode, in pixels. - * @property {boolean} isMaster - true if the GPU is the "master" or primary GPU, false or + * @property {boolean} isMaster - true if the GPU is the "master" or primary display, false or * undefined if it isn't. */ namespace display {
ValueNameDescription
Report details of the computer's CPUs.Report details of the computer's GPUs.Report details of the systems's displays.