From 0c59f983daacdd96ab12939e90361ce2a3186756 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Wed, 27 Feb 2019 09:34:05 +1300
Subject: [PATCH] Agent JSDoc tidying

---
 assignment-client/src/AgentScriptingInterface.h | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/assignment-client/src/AgentScriptingInterface.h b/assignment-client/src/AgentScriptingInterface.h
index 1f592a9f18..1242634dd5 100644
--- a/assignment-client/src/AgentScriptingInterface.h
+++ b/assignment-client/src/AgentScriptingInterface.h
@@ -63,21 +63,27 @@ public:
 
 public slots:
     /**jsdoc
-     * Set whether or not the script should emulate an avatar.
+     * Sets whether or not the script should emulate an avatar.
      * @function Agent.setIsAvatar
      * @param {boolean} isAvatar - <code>true</code> if the script should act as if an avatar, otherwise <code>false</code>.
+     * @example <caption>Make an assignment client script emulate an avatar.</caption>
+     * (function () {
+     *     Agent.setIsAvatar(true);
+     *     Avatar.displayName = "AC avatar";
+     *     print("Position: " + JSON.stringify(Avatar.position));  // 0, 0, 0
+     * }());
      */
     void setIsAvatar(bool isAvatar) const { _agent->setIsAvatar(isAvatar); }
 
     /**jsdoc
-     * Check whether or not the script is emulating an avatar.
+     * Checks whether or not the script is emulating an avatar.
      * @function Agent.isAvatar
      * @returns {boolean} <code>true</code> if the script is acting as if an avatar, otherwise <code>false</code>.
      */
     bool isAvatar() const { return _agent->isAvatar(); }
 
     /**jsdoc
-     * Play a sound from the position and with the orientation of the emulated avatar's head. No sound is played unless 
+     * Plays a sound from the position and with the orientation of the emulated avatar's head. No sound is played unless 
      * <code>isAvatar == true</code>.
      * @function Agent.playAvatarSound
      * @param {SoundObject} avatarSound - The sound to play.