From a1de44310f2f9ff89d1ac9abec84ebbd4faca329 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Tue, 15 May 2018 10:02:38 +1200
Subject: [PATCH] tabletInterface API JSDoc

---
 .../ui/src/ui/TabletScriptingInterface.h      | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/libraries/ui/src/ui/TabletScriptingInterface.h b/libraries/ui/src/ui/TabletScriptingInterface.h
index e74b846f02..f30c6de75e 100644
--- a/libraries/ui/src/ui/TabletScriptingInterface.h
+++ b/libraries/ui/src/ui/TabletScriptingInterface.h
@@ -44,6 +44,14 @@ class OffscreenQmlSurface;
  * @hifi-interface
  * @hifi-client-entity
  */
+/**jsdoc
+ * @namespace tabletInterface
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
+ * @deprecated This API is deprecated and will be removed. Use {@link Tablet} instead.
+ */
 class TabletScriptingInterface : public QObject, public Dependency {
     Q_OBJECT
 public:
@@ -83,6 +91,13 @@ public:
      * @param {string} name - Tablet name.
      * @returns {TabletProxy} Tablet instance.
      */
+    /**jsdoc
+     * Creates or returns a new TabletProxy and returns it.
+     * @function tabletInterface.getTablet
+     * @param {string} name - Tablet name.
+     * @returns {TabletProxy} Tablet instance.
+     * @deprecated This function is deprecated and will be removed. Use {@link Tablet.getTablet} instead.
+     */
     Q_INVOKABLE TabletProxy* getTablet(const QString& tabletId);
 
     void preloadSounds();
@@ -91,6 +106,11 @@ public:
      * @function Tablet.playSound
      * @param {Tablet.AudioEvents} sound
      */
+    /**jsdoc
+     * @function tabletInterface.playSound
+     * @param {Tablet.AudioEvents} sound
+     * @deprecated This function is deprecated and will be removed. Use {@link Tablet.playSound} instead.
+     */
     Q_INVOKABLE void playSound(TabletAudioEvents aEvent);
 
     void setToolbarMode(bool toolbarMode);
@@ -108,6 +128,12 @@ signals:
      * @function Tablet.tabletNotification
      * @returns {Signal}
      */
+    /**jsdoc
+     * Triggered when a tablet message or dialog is created.
+     * @function tabletInterface.tabletNotification
+     * @returns {Signal}
+     * @deprecated This function is deprecated and will be removed. Use {@link Tablet.tabletNotification} instead.
+     */
     void tabletNotification();
 
 private: