mirror of
https://github.com/overte-org/overte.git
synced 2025-08-07 18:10:37 +02:00
Doc review
This commit is contained in:
parent
c2b67f28d0
commit
ddffb8ab9a
2 changed files with 3 additions and 3 deletions
|
@ -52,7 +52,7 @@ protected:
|
||||||
|
|
||||||
protected slots:
|
protected slots:
|
||||||
/**jsdoc
|
/**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
|
* @function LocationBookmarks.deleteBookmark
|
||||||
*/
|
*/
|
||||||
virtual void deleteBookmark();
|
virtual void deleteBookmark();
|
||||||
|
|
|
@ -40,7 +40,7 @@ public:
|
||||||
/**jsdoc
|
/**jsdoc
|
||||||
* Gets the metaverse address associated with a bookmark.
|
* Gets the metaverse address associated with a bookmark.
|
||||||
* @function LocationBookmarks.getAddress
|
* @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.
|
* @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>
|
* @example <caption>Report the "Home" bookmark's metaverse address.</caption>
|
||||||
* print("Home bookmark's address: " + LocationBookmarks.getAddress("Home"));
|
* print("Home bookmark's address: " + LocationBookmarks.getAddress("Home"));
|
||||||
|
@ -50,7 +50,7 @@ public:
|
||||||
public slots:
|
public slots:
|
||||||
|
|
||||||
/**jsdoc
|
/**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.
|
* opened.
|
||||||
* @function LocationBookmarks.addBookmark
|
* @function LocationBookmarks.addBookmark
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue