From e9743d4c950a1e4591ec2690b12d9aa1de70561a Mon Sep 17 00:00:00 2001
From: Olivier Prat <olivier@zvork.fr>
Date: Thu, 2 Nov 2017 10:00:30 +0100
Subject: [PATCH] Added jsdoc to SelectionScriptingInterface

---
 .../scripting/SelectionScriptingInterface.h   | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/interface/src/scripting/SelectionScriptingInterface.h b/interface/src/scripting/SelectionScriptingInterface.h
index 28c1713050..d9003c2c32 100644
--- a/interface/src/scripting/SelectionScriptingInterface.h
+++ b/interface/src/scripting/SelectionScriptingInterface.h
@@ -56,11 +56,44 @@ public:
 
     GameplayObjects getList(const QString& listName);
 
+    /**jsdoc
+    * Prints out the list of avatars, entities and overlays stored in a particular selection.
+    * @function Selection.printList
+    * @param listName {string} name of the selection
+    */
     Q_INVOKABLE void printList(const QString& listName);
+    /**jsdoc
+    * Removes a named selection from the list of selections.
+    * @function Selection.removeListFromMap
+    * @param listName {string} name of the selection
+    * @returns {bool} true if the selection existed and was successfully removed.
+    */
     Q_INVOKABLE bool removeListFromMap(const QString& listName);
 
+    /**jsdoc
+    * Add an item in a selection.
+    * @function Selection.addToSelectedItemsList
+    * @param listName {string} name of the selection
+    * @param itemType {string} the type of the item (one of "avatar", "entity" or "overlay")
+    * @param id {EntityID} the Id of the item to add to the selection
+    * @returns {bool} true if the item was successfully added.
+    */
     Q_INVOKABLE bool addToSelectedItemsList(const QString& listName, const QString& itemType, const QUuid& id);
+    /**jsdoc
+    * Remove an item from a selection.
+    * @function Selection.removeFromSelectedItemsList
+    * @param listName {string} name of the selection
+    * @param itemType {string} the type of the item (one of "avatar", "entity" or "overlay")
+    * @param id {EntityID} the Id of the item to remove
+    * @returns {bool} true if the item was successfully removed.
+    */
     Q_INVOKABLE bool removeFromSelectedItemsList(const QString& listName, const QString& itemType, const QUuid& id);
+    /**jsdoc
+    * Remove all items from a selection.
+    * @function Selection.clearSelectedItemsList
+    * @param listName {string} name of the selection
+    * @returns {bool} true if the item was successfully cleared.
+    */
     Q_INVOKABLE bool clearSelectedItemsList(const QString& listName);
 
 signals: