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

HifiAbout API JSDoc

Browse source
This commit is contained in:
David Rowe 2019-02-15 08:00:36 +13:00
parent 2a338124ae
commit cc083afec6
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
interface/src/AboutUtil.h
View file

@ -16,14 +16,22 @@
#include <QObject>
/**jsdoc
* The <code>HifiAbout</code> API provides information about the version of Interface that is currently running. It also
* provides the ability to open a Web page in an Interface browser window.
*
* @namespace HifiAbout
*
* @hifi-interface
* @hifi-client-entity
*
* @property {string} buildDate
* @property {string} buildVersion
* @property {string} qtVersion
* @property {string} buildDate - The build date of Interface that is currently running. <em>Read-only.</em>
* @property {string} buildVersion - The build version of Interface that is currently running. <em>Read-only.</em>
* @property {string} qtVersion - The Qt version used in Interface that is currently running. <em>Read-only.</em>
*
* @example <caption>Report build information for the version of Interface currently running.</caption>
* print("HiFi build date: " + HifiAbout.buildDate); // 11 Feb 2019
* print("HiFi version: " + HifiAbout.buildVersion); // 0.78.0
* print("Qt version: " + HifiAbout.qtVersion); // 5.10.1
*/
class AboutUtil : public QObject {
@ -43,8 +51,9 @@ public:
public slots:
/**jsdoc
* Display a Web page in an Interface browser window.
* @function HifiAbout.openUrl
* @param {string} url
* @param {string} url - The URL of the Web page to display.
*/
void openUrl(const QString &url) const;
private: