initial fixes from ctralt david's comments

This commit is contained in:
milad 2018-04-19 13:40:57 -07:00
parent 364d193499
commit 42471c539b
3 changed files with 27 additions and 39 deletions

View file

@ -38,26 +38,10 @@ class AccountServicesScriptingInterface : public QObject {
* The AccountServices API contains helper functions related to user connectivity * The AccountServices API contains helper functions related to user connectivity
* *
* @namespace AccountServices * @namespace AccountServices
*/ * @property {string} AccountServices.username - To be completed
/**jsdoc * @property {boolean} AccountServices.loggedIn - To be completed
* To be completed * @property {string} AccountServices.findableBy - To be completed
* @property {string} AccountServices.username * @property {string} AccountServices.metaverseServerURL - - To be completed
* @static
*/
/**jsdoc
* To be completed
* @property {bool} AccountServices.loggedIn
* @static
*/
/**jsdoc
* To be completed
* @property {QString} AccountServices.findableBy
* @static
*/
/**jsdoc
* To be completed
* @property {QUrl} AccountServices.metaverseServerURL
* @static
*/ */
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged) Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged) Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged)
@ -79,8 +63,7 @@ public slots:
/**jsdoc /**jsdoc
* To be completed * To be completed
* @function AccountServices.checkAndSignalForAccessToken * @function AccountServices.checkAndSignalForAccessToken
* @static * @returns {boolean}
* @returns {bool}
*/ */
bool checkAndSignalForAccessToken(); bool checkAndSignalForAccessToken();
void logOut(); void logOut();
@ -133,7 +116,7 @@ signals:
/**jsdoc /**jsdoc
* To be completed * To be completed
* @function AccountServices.loggedInChanged * @function AccountServices.loggedInChanged
* @params {bool} loggedIn * @params {boolean} loggedIn
* @returns {Signal} * @returns {Signal}
*/ */
void loggedInChanged(bool loggedIn); void loggedInChanged(bool loggedIn);

View file

@ -28,11 +28,11 @@ class Audio : public AudioScriptingInterface {
* The Audio API features tools to help control audio contexts and settings. * The Audio API features tools to help control audio contexts and settings.
* *
* @namespace Audio * @namespace Audio
* @property {bool} muted - To Be Completed * @property {boolean} muted - To Be Completed
* @property {bool} noiseReduction - To Be Completed * @property {boolean} noiseReduction - To Be Completed
* @property {bool} inputVolume - To Be Completed * @property {boolean} inputVolume - To Be Completed
* @property {bool} inputLevel - To Be Completed * @property {boolean} inputLevel - To Be Completed
* @property {QString} context - To Be Completed * @property {string} context - To Be Completed
* @property {} devices - To Be Completed * @property {} devices - To Be Completed
*/ */
@ -67,20 +67,20 @@ public:
* To Be Completed * To Be Completed
* @function Audio.setInputDevice * @function Audio.setInputDevice
* @param {} device * @param {} device
* @param {bool} isHMD * @param {boolean} isHMD
*/ */
Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD); Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.setOutputDevice * @function Audio.setOutputDevice
* @param {} device * @param {} device
* @param {bool} isHMD * @param {boolean} isHMD
*/ */
Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD); Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.setReverb * @function Audio.setReverb
* @param {bool} enable * @param {boolean} enable
*/ */
Q_INVOKABLE void setReverb(bool enable); Q_INVOKABLE void setReverb(bool enable);
/**jsdoc /**jsdoc
@ -110,46 +110,51 @@ signals:
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.nop * @function Audio.nop
* @returns {signal} * @returns {Signal}
*/ */
void nop(); void nop();
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.nop * @function Audio.nop
* @param {bool} isMuted * @param {bool} isMuted
* @returns {signal} * @returns {Signal}
*/ */
void mutedChanged(bool isMuted); void mutedChanged(bool isMuted);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.noiseReductionChanged * @function Audio.noiseReductionChanged
* @param {bool} isEnabled * @param {bool} isEnabled
* @returns {signal} * @returns {Signal}
*/ */
void noiseReductionChanged(bool isEnabled); void noiseReductionChanged(bool isEnabled);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.inputVolumeChanged * @function Audio.inputVolumeChanged
* @param {float} volume * @param {float} volume
* @returns {signal} * @returns {Signal}
*/ */
void inputVolumeChanged(float volume); void inputVolumeChanged(float volume);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.inputLevelChanged * @function Audio.inputLevelChanged
* @param {float} level * @param {float} level
* @returns {signal} * @returns {Signal}
*/ */
void inputLevelChanged(float level); void inputLevelChanged(float level);
/**jsdoc /**jsdoc
* To Be Completed * To Be Completed
* @function Audio.contextChanged * @function Audio.contextChanged
* @param {string} context * @param {string} context
* @returns {signal} * @returns {Signal}
*/ */
void contextChanged(const QString& context); void contextChanged(const QString& context);
public slots: public slots:
/**jsdoc
* To Be Completed
* @function Audio.onContextChanged
* @returns {Signal}
*/
void onContextChanged(); void onContextChanged();
private slots: private slots:

View file

@ -211,14 +211,14 @@ public:
/**jsdoc /**jsdoc
* To be completed * To be completed
* @function Assets.initializeCache * @function Assets.initializeCache
* @returns {bool} * @returns {boolean}
*/ */
Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); } Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); }
/**jsdoc /**jsdoc
* To be completed * To be completed
* @function Assets.canWriteCacheValue * @function Assets.canWriteCacheValue
* @property {string} url * @property {string} url
* @returns {bool} * @returns {boolean}
*/ */
Q_INVOKABLE bool canWriteCacheValue(const QUrl& url); Q_INVOKABLE bool canWriteCacheValue(const QUrl& url);
/**jsdoc /**jsdoc