Browse Source

Update JSDocs

pull/36/head
Artur Arseniev 10 years ago
parent
commit
41c8ab6e9b
  1. 21
      src/asset_manager/main.js
  2. 79
      src/class_manager/main.js
  3. 3
      src/class_manager/model/ClassTag.js

21
src/asset_manager/main.js

@ -14,19 +14,6 @@
* ``` * ```
* *
* @module AssetManager * @module AssetManager
* @param {Object} config Configurations
* @param {Array<Object>} [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) { define(function(require) {
@ -105,7 +92,7 @@ define(function(require) {
/** /**
* Add new asset/s to the collection. URLs are supposed to be unique * Add new asset/s to the collection. URLs are supposed to be unique
* @param {string|Object|Array<string>|Array<Object>} asset URL strings or an objects representing the resource. * @param {string|Object|Array<string>|Array<Object>} asset URL strings or an objects representing the resource.
* @return {this} * @return {Model}
* @example * @example
* // In case of strings, would be interpreted as images * // In case of strings, would be interpreted as images
* assetManager.add('http://img.jpg'); * assetManager.add('http://img.jpg');
@ -220,8 +207,7 @@ define(function(require) {
/** /**
* Set new target * Set new target
* @param {Object} m Model * @param {Object} m Model
* * @private
* @return void
* */ * */
setTarget: function(m){ setTarget: function(m){
am.collection.target = m; am.collection.target = m;
@ -230,8 +216,7 @@ define(function(require) {
/** /**
* Set callback after asset was selected * Set callback after asset was selected
* @param {Object} f Callback function * @param {Object} f Callback function
* * @private
* @return void
* */ * */
onSelect: function(f){ onSelect: function(f){
am.collection.onSelect = f; am.collection.onSelect = f;

79
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) { define(function(require) {
/**
* @class ClassManager return function(config) {
* @param {Object} config Configurations
*
* */
var ClassManager = function(config)
{
var c = config || {}, var c = config || {},
def = require('./config/config'); def = require('./config/config');
this.ClassTags = require('./model/ClassTags'); ClassTags = require('./model/ClassTags');
this.ClassTagsView = require('./view/ClassTagsView'); ClassTagsView = require('./view/ClassTagsView');
for (var name in def) { for (var name in def) {
if (!(name in c)) if (!(name in c))
c[name] = def[name]; c[name] = def[name];
} }
this.classes = new this.ClassTags(c.defaults); classes = new ClassTags(c.defaults);
this.config = c; 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 * Add new class to collection only if it's not already exists
* @param {String} name Class name * @param {String} name Class name
* * @return {Model}
* @return {Object} Model class
* */ * */
addClass: function(name){ addClass: function(name){
var label = name; var label = name;
var c = this.getClass(name); var c = this.getClass(name);
if(!c) if(!c)
return this.classes.add({name: name, label: label}); return classes.add({name: name, label: label});
return c; return c;
}, },
@ -42,22 +72,19 @@ define(function(require) {
* *
* @return {Object|null} * @return {Object|null}
* */ * */
getClass : function(id) { getClass: function(id) {
var res = this.classes.where({name: id}); return classes.where({name: id})[0];
return res.length ? res[0] : null;
}, },
/** /**
* Get collection of classes * Get the collection of classes
* * @return {Collection}
* @return {Object}
* */ * */
getClasses : function() { getAllClasses: function() {
return this.classes; return classes;
}, },
};
}; };
return ClassManager;
}); });

3
src/class_manager/model/ClassTag.js

@ -1,8 +1,5 @@
define(['backbone'], define(['backbone'],
function (Backbone) { function (Backbone) {
/**
* @class ClassTag
* */
return Backbone.Model.extend({ return Backbone.Model.extend({
defaults: { defaults: {

Loading…
Cancel
Save