From ddffb8ab9ae8ed445a99c8e3cedd03c53f952f09 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 23 Jul 2019 07:25:34 +1200 Subject: [PATCH] Doc review --- interface/src/Bookmarks.h | 2 +- interface/src/LocationBookmarks.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/interface/src/Bookmarks.h b/interface/src/Bookmarks.h index a5b8254e53..e4480b7552 100644 --- a/interface/src/Bookmarks.h +++ b/interface/src/Bookmarks.h @@ -52,7 +52,7 @@ protected: protected slots: /**jsdoc - * Prompts the user to delete a bookmark: the user can select the bookmark to delete in the dialog that is opened. + * Prompts the user to delete a bookmark. The user can select the bookmark to delete in the dialog that is opened. * @function LocationBookmarks.deleteBookmark */ virtual void deleteBookmark(); diff --git a/interface/src/LocationBookmarks.h b/interface/src/LocationBookmarks.h index bf6d09889b..3af6704a92 100644 --- a/interface/src/LocationBookmarks.h +++ b/interface/src/LocationBookmarks.h @@ -40,7 +40,7 @@ public: /**jsdoc * Gets the metaverse address associated with a bookmark. * @function LocationBookmarks.getAddress - * @param {string} bookmarkName - Name of the bookmark to get the metaverse address for. {Case sensitive.) + * @param {string} bookmarkName - Name of the bookmark to get the metaverse address for {case sensitive). * @returns {string} The metaverse address for the bookmark. If the bookmark does not exist, "" is returned. * @example Report the "Home" bookmark's metaverse address. * print("Home bookmark's address: " + LocationBookmarks.getAddress("Home")); @@ -50,7 +50,7 @@ public: public slots: /**jsdoc - * Prompts the user to bookmark their current location: the user can specify the name of the bookmark in the dialog that is + * Prompts the user to bookmark their current location. The user can specify the name of the bookmark in the dialog that is * opened. * @function LocationBookmarks.addBookmark */