Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-06-26 22:30:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Doc review

Browse source
This commit is contained in:
David Rowe 2019-07-23 07:36:11 +12:00
parent 9165a04641
commit a36bcbb2ed
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
interface/src/AvatarBookmarks.h
View file

@ -38,7 +38,7 @@ public:
/**jsdoc /**jsdoc
* Gets the details of an avatar bookmark. * Gets the details of an avatar bookmark.
* @function AvatarBookmarks.getBookmark * @function AvatarBookmarks.getBookmark
* @param {string} bookmarkName - The name of the avatar bookmark. (Case sensitive.) * @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
* @returns {AvatarBookmarks.BookmarkData|{}} The bookmark data if the bookmark exists, <code>{}</code> if it doesn't. * @returns {AvatarBookmarks.BookmarkData|{}} The bookmark data if the bookmark exists, <code>{}</code> if it doesn't.
*/ */
Q_INVOKABLE QVariantMap getBookmark(const QString& bookmarkName); Q_INVOKABLE QVariantMap getBookmark(const QString& bookmarkName);
@ -47,7 +47,7 @@ public slots:
/**jsdoc /**jsdoc
* Adds a new (or updates an existing) avatar bookmark with your current avatar model, scale, and avatar entities. * Adds a new (or updates an existing) avatar bookmark with your current avatar model, scale, and avatar entities.
* @function AvatarBookmarks.addBookmark * @function AvatarBookmarks.addBookmark
* @param {string} bookmarkName - The name of the avatar bookmark. (Case sensitive.) * @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
* @example <caption>Add a new avatar bookmark and report the bookmark data.</caption> * @example <caption>Add a new avatar bookmark and report the bookmark data.</caption>
* var bookmarkName = "New Bookmark"; * var bookmarkName = "New Bookmark";
* AvatarBookmarks.addBookmark(bookmarkName); * AvatarBookmarks.addBookmark(bookmarkName);
@ -60,7 +60,7 @@ public slots:
* Updates an existing bookmark with your current avatar model, scale, and wearables. No action is taken if the bookmark * Updates an existing bookmark with your current avatar model, scale, and wearables. No action is taken if the bookmark
* doesn't exist. * doesn't exist.
* @function AvatarBookmarks.saveBookmark * @function AvatarBookmarks.saveBookmark
* @param {string} bookmarkName - The name of the avatar bookmark. (Case sensitive.) * @param {string} bookmarkName - The name of the avatar bookmark (case sensitive).
*/ */
void saveBookmark(const QString& bookmarkName); void saveBookmark(const QString& bookmarkName);
@ -68,14 +68,14 @@ public slots:
* Loads an avatar bookmark, setting your avatar model, scale, and avatar entities (or attachments if an old bookmark) to * Loads an avatar bookmark, setting your avatar model, scale, and avatar entities (or attachments if an old bookmark) to
* those in the bookmark. * those in the bookmark.
* @function AvatarBookmarks.loadBookmark * @function AvatarBookmarks.loadBookmark
* @param {string} bookmarkName - The name of the avatar bookmark to load. (Case sensitive.) * @param {string} bookmarkName - The name of the avatar bookmark to load (case sensitive).
*/ */
void loadBookmark(const QString& bookmarkName); void loadBookmark(const QString& bookmarkName);
/**jsdoc /**jsdoc
* Deletes an avatar bookmark. * Deletes an avatar bookmark.
* @function AvatarBookmarks.removeBookmark * @function AvatarBookmarks.removeBookmark
* @param {string} bookmarkName - The name of the avatar bookmark to delete. (Case sensitive.) * @param {string} bookmarkName - The name of the avatar bookmark to delete (case sensitive).
*/ */
void removeBookmark(const QString& bookmarkName); void removeBookmark(const QString& bookmarkName);