Paths API JSDoc improvements

This commit is contained in:
David Rowe 2017-11-16 12:58:03 +13:00
parent 41e929c8a2
commit a29a3ff88d

View file

@ -19,10 +19,13 @@
#include "DependencyManager.h"
/**jsdoc
* The Paths API provides absolute paths to the scripts and resources directories.
*
* @namespace Paths
* @deprecated The Paths API is deprecated. Use {@link Script.resolvePath} and {@link Script.resourcesPath} instead.
* @readonly
* @property {string} defaultScripts The path to the scripts directory. <em>Readonly</em>
* @property {string} resources The path to the resources directory. <em>Readonly</em>
* @property {string} defaultScripts The path to the defaultScripts directory. <em>Readonly</em>
*/
class PathUtils : public QObject, public Dependency {
Q_OBJECT