Doc update

ekelokorpi · Jul 29, 2014 · b17c89e · b17c89e
1 parent ec01a07
commit b17c89e
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 7 deletions.
diff --git a/src/engine/audio.js b/src/engine/audio.js
@@ -9,6 +9,7 @@ game.module(
 'use strict';
 
 /**
+    Audio manager.
     @class Audio
     @extends game.Class
 **/

diff --git a/src/engine/renderer.js b/src/engine/renderer.js
@@ -305,13 +305,35 @@ game.TilingSprite = game.PIXI.TilingSprite.extend({
 });
 
 /**
-    Sprite animation.
-    http://www.goodboydigital.com/pixijs/docs/classes/MovieClip.html
+    Frame by frame animation.
     @class Animation
+    @extends game.Container
     @constructor
     @param {Array} textures
 **/
 game.Animation = game.PIXI.MovieClip.extend({
+    /**
+        @property {Number} animationSpeed
+        @default 1
+    **/
+    /**
+        @property {Array} textures
+    **/
+    /**
+        @property {Boolean} loop
+    **/
+    /**
+        @property {Number} currentFrame
+    **/
+    /**
+        @property {Boolean} playing
+    **/
+    /**
+        @property {Number} totalFrames
+    **/
+    /**
+        @property {Function} onComplete
+    **/
     init: function(textures) {
         if (typeof textures === 'string') {
             var frames = Array.prototype.slice.call(arguments);
@@ -325,15 +347,23 @@ game.Animation = game.PIXI.MovieClip.extend({
         this._super(textures);
     },
 
-    /**
-        Add to container.
-        @method addTo
-        @param {game.Container} container
-    **/
     addTo: function(container) {
         container.addChild(this);
         return this;
     }
+
+    /**
+        @method play
+    **/
+    /**
+        @method stop
+    **/
+    /**
+        @method gotoAndPlay
+    **/
+    /**
+        @method gotoAndStop
+    **/
 });
 
 });