Permalink
Browse files

doc Improve Aria.load method documentation

Close #943
  • Loading branch information...
1 parent 1bc334f commit 862f4e5a233d97b81e0cca8039981e994f90f1cb @flongo flongo committed Jan 22, 2014
Showing with 20 additions and 11 deletions.
  1. +19 −11 src/aria/Aria.js
  2. +1 −0 src/aria/core/MultiLoader.js
View
@@ -1335,20 +1335,28 @@
*
* <pre>
* {
- * classes : [] // {Array of String} - classpaths to be loaded (dot is a separator)
- * oncomplete : {
- * fn: {Function} // the callback function - may be called synchronously if all dependencies are already available
- * scope: {Object} // [optional] scope object (i.e. 'this') to associate to fn - if not provided, the Aria object will be used
- * args: {Object} // [optional] callback arguments (passed back as an argument to the callback function)
- * },
- * onerror: {
- * fn: ...
- * ...,
- * override:true // used to disable error warnings
- * }
+ * classes : {Array} list of JS classpaths to be loaded
+ * templates : {Array} list of TPL classpaths to be loaded
+ * resources : {Array} list of RES classpaths to be loaded
+ * css : {Array} list of TPL.CSS classpaths to be loaded
+ * tml : {Array} list of TML classpaths to be loaded
+ * cml : {Array} list of CML classpaths to be loaded
+ * txt : {Array} list of TXT classpaths to be loaded
+ * oncomplete : {
+ * fn : {Function} the callback function - may be called synchronously if all dependencies are already available
+ * scope : {Object} [optional] scope object (i.e. 'this') to associate to fn - if not provided, the Aria object will be used
+ * args: {Object} [optional] callback arguments (passed back as argument when the callback is called)
+ * },
+ * onerror : {
+ * fn : {Function} the callback function called in case of load error
+ * scope : {Object} [optional] scope object
+ * args: {Object} [optional] callback arguments
+ * override: {Boolean} [optional] used to disable error warnings
+ * }
* }
* </pre>
*
+ *
* If there is no need to specify the <code>scope</code> and <code>args</code>, the callbacks can be passed
* directly as functions: e.g. <code>oncomplete: function () {...}</code> instead of
* <code>oncomplete: {fn: function () {...}}</code>
@@ -41,6 +41,7 @@ Aria.classDefinition({
* fn : {Function} the callback function called in case of load error
* scope : {Object} [optional] scope object
* args: {Object} [optional] callback arguments
+ * override: {Boolean} [optional] used to disable error warnings
* }
* }
* </pre>

0 comments on commit 862f4e5

Please sign in to comment.