Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-25 17:14:59 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doc review

Browse source
This commit is contained in:
David Rowe 2019-07-23 07:25:34 +12:00
parent c2b67f28d0
commit ddffb8ab9a
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
interface/src/Bookmarks.h
View file

@ -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();

4
interface/src/LocationBookmarks.h
View file

@ -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, <code>""</code> is returned.
* @example <caption>Report the "Home" bookmark's metaverse address.</caption>
* 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
*/