From 06d19333cd401a705858f87758945839a69fcf3e Mon Sep 17 00:00:00 2001
From: Luis Leiva <lleiva@sciling.com>
Date: Mon, 11 Dec 2017 23:04:50 +0100
Subject: [PATCH] Updated doc

---
 jquery.sketchable.animate.js |  5 +++--
 jquery.sketchable.js         |  2 +-
 jquery.sketchable.memento.js | 12 ++++++------
 jsketch.js                   |  2 --
 sketchable.animate.js        |  5 +++--
 sketchable.memento.js        | 12 ++++++------
 6 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/jquery.sketchable.animate.js b/jquery.sketchable.animate.js
index f55f449..dbb4038 100644
--- a/jquery.sketchable.animate.js
+++ b/jquery.sketchable.animate.js
@@ -61,6 +61,7 @@
 
     /**
      * Cancel current animation.
+     * @return {AnimateSketch}.
      */
     this.cancel = function() {
       cancelAnimationFrame(raf);
@@ -107,7 +108,7 @@
   /**
    * Animate plugin constructor for jQuery Sketchable instances.
    * @param {jQuery} $instance - jQuery Sketchable instance.
-   * @memberof $.fn.sketchable.plugins
+   * @namespace $.fn.sketchable.plugins.animate
    */
   $.fn.sketchable.plugins.animate = function($instance) {
     // Access the instance configuration.
@@ -156,7 +157,7 @@
         /**
          * Animate canvas strokes.
          * @return {jQuery} jQuery sketchable element.
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.animate
          * @example jqueryElem.sketchable('strokes', strokesArray).sketchable('animate.strokes');
          * @example
          * // Accessing event hooks:
diff --git a/jquery.sketchable.js b/jquery.sketchable.js
index c22d8fe..9c9cf76 100644
--- a/jquery.sketchable.js
+++ b/jquery.sketchable.js
@@ -244,7 +244,7 @@
    * Note: This is equivalent to accessing `Sketchable.prototype` in the non-jQuery version.
    * @namespace $.fn.sketchable.api
    * @type {object}
-   * @see Sketchable.prototype
+   * @see Sketchable
    */
   $.fn.sketchable.api = api;
 
diff --git a/jquery.sketchable.memento.js b/jquery.sketchable.memento.js
index a07953a..619acd1 100644
--- a/jquery.sketchable.memento.js
+++ b/jquery.sketchable.memento.js
@@ -165,7 +165,7 @@
   /**
    * Memento plugin constructor for jQuery Sketchable instances.
    * @param {jQuery} $instance - jQuery sketchable instance.
-   * @memberof $.fn.sketchable.plugins
+   * @namespace $.fn.sketchable.plugins.memento
    */
   $.fn.sketchable.plugins.memento = function($instance) {
     // Access the instance configuration.
@@ -217,7 +217,7 @@
         /**
          * Goes back to the previous CANVAS state, if available.
          * @return {jQuery} jQuery sketchable element.
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.memento
          * @example jqueryElem.sketchable('memento.undo');
          */
         undo: function() {
@@ -228,7 +228,7 @@
         /**
          * Goes forward to the previous CANVAS state, if available.
          * @return {jQuery} jQuery sketchable element.
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.memento
          * @example jqueryElem.sketchable('memento.redo');
          */
         redo: function() {
@@ -239,7 +239,7 @@
         /**
          * Save a snapshot of the current CANVAS.
          * @return {jQuery} jQuery sketchable element.
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.memento
          * @example jqueryElem.sketchable('memento.save');
          */
         save: function() {
@@ -250,7 +250,7 @@
         /**
          * Read current CANVAS state: `{ image:String, strokes:Array }`.
          * @return {object}
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.memento
          * @example var state = jqueryElem.sketchable('memento.state');
          */
         state: function() {
@@ -263,7 +263,7 @@
          * @param {string} state.image - Base64 image.
          * @param {array} state.strokes - Associated strokes.
          * @return {jQuery} jQuery sketchable element.
-         * @memberof $.fn.sketchable
+         * @memberof $.fn.sketchable.plugins.memento
          * @example jqueryElem.sketchable('memento.restore', state);
          */
         restore: function(state) {
diff --git a/jsketch.js b/jsketch.js
index 91de12e..d8d1a3a 100644
--- a/jsketch.js
+++ b/jsketch.js
@@ -44,8 +44,6 @@
   /**
    * jSketch methods (publicly extensible).
    * @ignore
-   * @memberof jSketch
-   * @see jSketch
    */
   jSketch.prototype = {
     /**
diff --git a/sketchable.animate.js b/sketchable.animate.js
index bc64410..c8cbc13 100644
--- a/sketchable.animate.js
+++ b/sketchable.animate.js
@@ -63,6 +63,7 @@
 
     /**
      * Cancel current animation.
+     * @return {AnimateSketch}.
      */
     this.cancel = function() {
       cancelAnimationFrame(raf);
@@ -109,7 +110,7 @@
   /**
    * Animate plugin constructor for jQuery Sketchable instances.
    * @param {Sketchable} instance - Sketchable element.
-   * @memberof Sketchable#plugins
+   * @namespace Sketchable.plugins.animate
    */
   Sketchable.prototype.plugins.animate = function(instance) {
     // Access the instance configuration.
@@ -158,7 +159,7 @@
         /**
          * Animate canvas strokes.
          * @return {Sketchable} instance Sketchable element.
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.animate
          * @example sketchableInstance.strokes(strokeArray).animate.strokes();
          * @example
          * // Accessing event hooks:
diff --git a/sketchable.memento.js b/sketchable.memento.js
index 49fe66b..0a7b0e4 100644
--- a/sketchable.memento.js
+++ b/sketchable.memento.js
@@ -167,7 +167,7 @@
   /**
    * Memento plugin constructor for Sketchable instances.
    * @param {Sketchable} instance - Sketchable element.
-   * @memberof Sketchable#plugins
+   * @namespace Sketchable.plugins.memento
    */
   Sketchable.prototype.plugins.memento = function(instance) {
     // Access the instance configuration.
@@ -219,7 +219,7 @@
         /**
          * Goes back to the previous CANVAS state, if available.
          * @return {Sketchable} Sketchable instance.
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.memento
          * @example sketchableInstance.memento.undo();
          */
         undo: function() {
@@ -230,7 +230,7 @@
         /**
          * Goes forward to the previous CANVAS state, if available.
          * @return {Sketchable} Sketchable instance.
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.memento
          * @example sketchableInstance.memento.redo();
          */
         redo: function() {
@@ -241,7 +241,7 @@
         /**
          * Save a snapshot of the current CANVAS.
          * @return {Sketchable} Sketchable instance.
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.memento
          * @example sketchableInstance.memento.save();
          */
         save: function() {
@@ -252,7 +252,7 @@
         /**
          * Read current CANVAS state: `{ image:String, strokes:Array }`.
          * @return {object}
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.memento
          * @example var state = sketchableInstance.memento.state();
          */
         state: function() {
@@ -265,7 +265,7 @@
          * @param {string} state.image - Base64 image.
          * @param {array} state.strokes - Associated strokes.
          * @return {Sketchable} Sketchable instance.
-         * @memberof Sketchable
+         * @memberof Sketchable.plugins.memento
          * @example
          * var someState = sketchableInstance.memento.state();
          * sketchableInstance.memento.restore(someState);