Interim JSDoc for Recording

libraries/script-engine/src/RecordingScriptingInterface.h

@@ -23,6 +23,9 @@
 class QScriptEngine;
 class QScriptValue;
 
+/**jsdoc
+ * @namespace Recording
+ */
 class RecordingScriptingInterface : public QObject, public Dependency {
     Q_OBJECT
 
@@ -32,43 +35,194 @@ public:
     void setScriptEngine(QSharedPointer<BaseScriptEngine> scriptEngine) { _scriptEngine = scriptEngine; }
 
 public slots:
+
+    /**jsdoc
+     * @function Recording.loadRecording
+     * @param {string} url
+     * @param {Recording~loadRecordingCallback} [callback=null]
+     */
+    /**jsdoc
+     * Called when {@link Recording.loadRecording} is complete.
+     * @callback Recording~loadRecordingCallback
+     * @param {boolean} success
+     * @param {string} url
+     */
     void loadRecording(const QString& url, QScriptValue callback = QScriptValue());
 
+
+    /**jsdoc
+     * @function Recording.startPlaying
+     */
     void startPlaying();
+
+    /**jsdoc
+     * @function Recording.pausePlayer
+     */
     void pausePlayer();
+
+    /**jsdoc
+     * @function Recording.stopPlaying
+     */
     void stopPlaying();
+
+    /**jsdoc
+     * @function Recording.isPlaying
+     * @returns {boolean}
+     */
     bool isPlaying() const;
+
+    /**jsdoc
+     * @function Recording.isPaused
+     * @returns {boolean}
+     */
     bool isPaused() const;
 
+
+    /**jsdoc
+     * @function Recording.playerElapsed
+     * @returns {number}
+     */
     float playerElapsed() const;
+
+    /**jsdoc
+     * @function Recording.playerLength
+     * @returns {number}
+     */
     float playerLength() const;
 
+
+    /**jsdoc
+     * @function Recording.setPlayerVolume
+     * @param {number} volume
+     */
     void setPlayerVolume(float volume);
+
+    /**jsdoc
+     * @function Recording.setPlayerAudioOffset
+     * @param {number} audioOffset
+     */
     void setPlayerAudioOffset(float audioOffset);
+
+    /**jsdoc
+     * @function Recording.setPlayerTime
+     * @param {number} time
+     */
     void setPlayerTime(float time);
+
+    /**jsdoc
+     * @function Recording.setPlayerLoop
+     * @param {boolean} loop
+     */
     void setPlayerLoop(bool loop);
 
+
+    /**jsdoc
+     * @function Recording.setPlayerUseDisplayName
+     * @param {boolean} useDisplayName
+     */
     void setPlayerUseDisplayName(bool useDisplayName);
+
+    /**jsdoc
+     * @function Recording.setPlayerUseAttachments
+     * @param {boolean} useAttachments
+     */
     void setPlayerUseAttachments(bool useAttachments);
+
+    /**jsdoc
+     * @function Recording.setPlayerUseHeadModel
+     * @param {boolean} useHeadModel
+     */
     void setPlayerUseHeadModel(bool useHeadModel);
+
+    /**jsdoc
+     * @function Recording.setPlayerUseSkeletonModel
+     * @param {boolean} useSkeletonModel
+     */
     void setPlayerUseSkeletonModel(bool useSkeletonModel);
+
+    /**jsdoc
+     * @function Recording.setPlayFromCurrentLocation
+     * @param {boolean} playFromCurrentLocation
+     */
     void setPlayFromCurrentLocation(bool playFromCurrentLocation);
 
+
+    /**jsdoc
+     * @function Recording.getPlayerUseDisplayName
+     * @returns {boolean}
+     */
     bool getPlayerUseDisplayName() { return _useDisplayName; }
+
+    /**jsdoc
+     * @function Recording.getPlayerUseAttachments
+     * @returns {boolean}
+     */
     bool getPlayerUseAttachments() { return _useAttachments; }
+
+    /**jsdoc
+     * @function Recording.getPlayerUseHeadModel
+     * @returns {boolean}
+     */
     bool getPlayerUseHeadModel() { return _useHeadModel; }
+
+    /**jsdoc
+     * @function Recording.getPlayerUseSkeletonModel
+     * @returns {boolean}
+     */
     bool getPlayerUseSkeletonModel() { return _useSkeletonModel; }
+
+    /**jsdoc
+     * @function Recording.getPlayFromCurrentLocation
+     * @returns {boolean}
+     */
     bool getPlayFromCurrentLocation() { return _playFromCurrentLocation; }
 
+
+    /**jsdoc
+     * @function Recording.
+     */
     void startRecording();
+
+    /**jsdoc
+     * @function Recording.
+     */
     void stopRecording();
+
+    /**jsdoc
+     * @function Recording.isRecording
+     * @returns {boolean}
+     */
     bool isRecording() const;
 
+
+    /**jsdoc
+     * @function Recording.recorderElapsed
+     * @returns {number}
+     */
     float recorderElapsed() const;
 
+
+    /**jsdoc
+     * @function Recording.getDefaultRecordingSaveDirectory
+     * @returns {string}
+     */
     QString getDefaultRecordingSaveDirectory();
+
+    /**jsdoc
+     * @function Recording.saveRecording
+     * @param {string} filename
+     */
     void saveRecording(const QString& filename);
+
+    /**jsdoc
+     * @function Recording.saveRecordingToAsset
+     * @param {function} getClipAtpUrl
+     */
     bool saveRecordingToAsset(QScriptValue getClipAtpUrl);
+
+    /**jsdoc
+     * @function Recording.loadLastRecording
+     */
     void loadLastRecording();
 
 protected: