more documentation for js util »setup«

This commit is contained in:
Felix Hamann 2019-02-24 14:05:59 +01:00
parent 695d0a9978
commit f5ee39eafa

View File

@ -8,8 +8,8 @@
/**
* setup function to initiate a util (utilName) on a scope (sope) with options (options).
*
* A util has to define an itself at `window.utils` as shown for the `autoSubmit` util:
* `window.utils.autoSubmit = function(wrapper, options) { ... };`
* Utils need to be defined as property of `window.utils` and need to accept a scope and (optionally) options.
* Example: `window.utils.autoSubmit = function(scope, options) { ... };`
*/
window.utils.setup = function(utilName, scope, options) {