From bf7863ad10ee2a0ae0ee0a827bf45c138f00f3e2 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 12 May 2018 14:23:03 +1200 Subject: [PATCH] LocationBookmarks API JSDoc stubs --- interface/src/Bookmarks.h | 3 +++ interface/src/LocationBookmarks.h | 16 ++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/interface/src/Bookmarks.h b/interface/src/Bookmarks.h index 7bd32ce7f1..dc08d4b279 100644 --- a/interface/src/Bookmarks.h +++ b/interface/src/Bookmarks.h @@ -51,6 +51,9 @@ protected slots: /**jsdoc * @function AvatarBookmarks.deleteBookmark */ + /**jsdoc + * @function LocationBookmarks.deleteBookmark + */ void deleteBookmark(); private: diff --git a/interface/src/LocationBookmarks.h b/interface/src/LocationBookmarks.h index 39abea9ba4..70ea50e2e7 100644 --- a/interface/src/LocationBookmarks.h +++ b/interface/src/LocationBookmarks.h @@ -16,6 +16,13 @@ #include "Bookmarks.h" +/**jsdoc + * @namespace LocationBookmarks + * + * @hifi-client-entity + * @hifi-interface + */ + class LocationBookmarks : public Bookmarks, public Dependency { Q_OBJECT SINGLETON_DEPENDENCY @@ -27,7 +34,16 @@ public: static const QString HOME_BOOKMARK; public slots: + + /**jsdoc + * @function LocationBookmarks.addBookmark + */ void addBookmark(); + + /**jsdoc + * @function LocationBookmarks.setHomeLocationToAddress + * @param {string} address + */ void setHomeLocationToAddress(const QVariant& address); protected: