From 74617822fa518d0453c7d0649214c4570a462558 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 12 May 2018 16:32:33 +1200 Subject: [PATCH] Snapshot API JSDoc stubs --- interface/src/ui/Snapshot.h | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/interface/src/ui/Snapshot.h b/interface/src/ui/Snapshot.h index 606313f3c3..4dc937382b 100644 --- a/interface/src/ui/Snapshot.h +++ b/interface/src/ui/Snapshot.h @@ -34,6 +34,14 @@ private: QUrl _URL; }; + +/**jsdoc + * @namespace Snapshot + * + * @hifi-interface + * @hifi-client-entity + */ + class Snapshot : public QObject, public Dependency { Q_OBJECT SINGLETON_DEPENDENCY @@ -46,11 +54,28 @@ public: static void uploadSnapshot(const QString& filename, const QUrl& href = QUrl("")); signals: + + /**jsdoc + * @function Snapshot.snapshotLocationSet + * @param {string} location + * @returns {Signal} + */ void snapshotLocationSet(const QString& value); public slots: + + /**jsdoc + * @function Snapshot.getSnapshotsLocation + * @returns {string} + */ Q_INVOKABLE QString getSnapshotsLocation(); + + /**jsdoc + * @function Snapshot.setSnapshotsLocation + * @param {String} location + */ Q_INVOKABLE void setSnapshotsLocation(const QString& location); + private: static QFile* savedFileForSnapshot(QImage& image, bool isTemporary,