Resource API JSDoc stub

This commit is contained in:
David Rowe 2018-05-15 10:32:36 +12:00
parent a1de44310f
commit 8ea3a733ca

View file

@ -86,7 +86,6 @@ private:
/// Wrapper to expose resources to JS/QML /// Wrapper to expose resources to JS/QML
class ScriptableResource : public QObject { class ScriptableResource : public QObject {
/**jsdoc /**jsdoc
* @constructor Resource * @constructor Resource
* *
@ -98,12 +97,15 @@ class ScriptableResource : public QObject {
* @property {string} url - URL of this resource. * @property {string} url - URL of this resource.
* @property {Resource.State} state - Current loading state. * @property {Resource.State} state - Current loading state.
*/ */
/**jsdoc
* @namespace Resource
* @variation 0
* @property {Resource.State} State
*/
Q_OBJECT Q_OBJECT
Q_PROPERTY(QUrl url READ getURL) Q_PROPERTY(QUrl url READ getURL)
Q_PROPERTY(int state READ getState NOTIFY stateChanged) Q_PROPERTY(int state READ getState NOTIFY stateChanged)
public: public:
/**jsdoc /**jsdoc
@ -115,7 +117,6 @@ public:
* @property {number} FINISHED - The resource has completely finished loading and is ready. * @property {number} FINISHED - The resource has completely finished loading and is ready.
* @property {number} FAILED - Downloading the resource has failed. * @property {number} FAILED - Downloading the resource has failed.
*/ */
enum State { enum State {
QUEUED, QUEUED,
LOADING, LOADING,