diff --git a/src/asset_manager/main.js b/src/asset_manager/main.js index 759e4c831..df18405f4 100644 --- a/src/asset_manager/main.js +++ b/src/asset_manager/main.js @@ -14,19 +14,6 @@ * ``` * * @module AssetManager - * @param {Object} config Configurations - * @param {Array} [config.assets=[]] Default assets - * @example - * ... - * assetManager: { - * assets: [ - * {src:'path/to/image.png'}, - * ... - * ], - * upload: 'http://dropbox/path', // set to false to disable it - * uploadText: 'Drop files here or click to upload', - * } - * ... */ define(function(require) { @@ -105,7 +92,7 @@ define(function(require) { /** * Add new asset/s to the collection. URLs are supposed to be unique * @param {string|Object|Array|Array} asset URL strings or an objects representing the resource. - * @return {this} + * @return {Model} * @example * // In case of strings, would be interpreted as images * assetManager.add('http://img.jpg'); @@ -220,8 +207,7 @@ define(function(require) { /** * Set new target * @param {Object} m Model - * - * @return void + * @private * */ setTarget: function(m){ am.collection.target = m; @@ -230,8 +216,7 @@ define(function(require) { /** * Set callback after asset was selected * @param {Object} f Callback function - * - * @return void + * @private * */ onSelect: function(f){ am.collection.onSelect = f; diff --git a/src/class_manager/main.js b/src/class_manager/main.js index 19eb67c73..924835089 100644 --- a/src/class_manager/main.js +++ b/src/class_manager/main.js @@ -1,38 +1,68 @@ +/** + * * [add](#add) + * * [get](#get) + * * [getAll](#getall) + * * [remove](#remove) + * * [store](#store) + * * [load](#load) + * * [render](#render) + * + * Before using methods you should get first the module from the editor instance, in this way: + * + * ```js + * var classManager = editor.ClassManager; + * ``` + * + * @module ClassManager + */ define(function(require) { - /** - * @class ClassManager - * @param {Object} config Configurations - * - * */ - var ClassManager = function(config) - { + + return function(config) { var c = config || {}, def = require('./config/config'); - this.ClassTags = require('./model/ClassTags'); - this.ClassTagsView = require('./view/ClassTagsView'); + ClassTags = require('./model/ClassTags'); + ClassTagsView = require('./view/ClassTagsView'); for (var name in def) { if (!(name in c)) c[name] = def[name]; } - this.classes = new this.ClassTags(c.defaults); - this.config = c; - }; + classes = new ClassTags(c.defaults); + config = c; + + return { + + config: config, + + ClassTags: ClassTags, + + ClassTagsView: ClassTagsView, - ClassManager.prototype = { + /** + * Name of the module + * @type {String} + * @private + */ + name: 'ClassManager', + + /** + * Indicates if module is public + * @type {Boolean} + * @private + */ + public: true, /** * Add new class to collection only if it's not already exists * @param {String} name Class name - * - * @return {Object} Model class + * @return {Model} * */ addClass: function(name){ var label = name; var c = this.getClass(name); if(!c) - return this.classes.add({name: name, label: label}); + return classes.add({name: name, label: label}); return c; }, @@ -42,22 +72,19 @@ define(function(require) { * * @return {Object|null} * */ - getClass : function(id) { - var res = this.classes.where({name: id}); - return res.length ? res[0] : null; + getClass: function(id) { + return classes.where({name: id})[0]; }, /** - * Get collection of classes - * - * @return {Object} + * Get the collection of classes + * @return {Collection} * */ - getClasses : function() { - return this.classes; + getAllClasses: function() { + return classes; }, + }; }; - return ClassManager; - }); \ No newline at end of file diff --git a/src/class_manager/model/ClassTag.js b/src/class_manager/model/ClassTag.js index 328b68db3..2b8bfed25 100644 --- a/src/class_manager/model/ClassTag.js +++ b/src/class_manager/model/ClassTag.js @@ -1,8 +1,5 @@ define(['backbone'], function (Backbone) { - /** - * @class ClassTag - * */ return Backbone.Model.extend({ defaults: {