jsdoc: fix events links and plugins definition

Author: mistic100

.jsdoc.json

@@ -26,7 +26,7 @@
       {"kind": "global", "title": "Globals", "summary": "All documented globals."},
       {"kind": "mixin", "title": "Mixins", "summary": "All documented mixins."},
       {"kind": "interface", "title": "Interfaces", "summary": "All documented interfaces."},
-      {"kind": "module", "title": "Plugins", "summary": "All documented modules."},
+      {"kind": "module", "title": "Modules", "summary": "All documented modules."},
       {"kind": "event", "title": "Events", "summary": "All documented events."},
       {"kind": "namespace", "title": "Namespaces", "summary": "All documented namespaces."},
       {"kind": "tutorial", "title": "Tutorials", "summary": "All available tutorials."}

Gruntfile.js

@@ -17,6 +17,7 @@ module.exports = function(grunt) {
         js_core_files: [
             'src/main.js',
             'src/defaults.js',
+            'src/plugins.js',
             'src/core.js',
             'src/public.js',
             'src/data.js',

build/jsdoc.md

@@ -2,10 +2,10 @@
 
 # Entry point: [$.fn.QueryBuilder](external-_jQuery.fn_.html)
 
-## [QueryBuilder](QueryBuilder.html)
+# [QueryBuilder](QueryBuilder.html)
 
-## [Rule](Rule.html) & [Group](Group.html)
+# [Rule](Rule.html) & [Group](Group.html)
 
-## [Events](list_event.html)
+# [Events](list_event.html)
 
-## [Plugins](list_module.html)
+# [Plugins](module-plugins.html)

src/core.js

@@ -321,7 +321,7 @@ QueryBuilder.prototype.bindEvents = function() {
  * @param {object} [data] - group custom data
  * @param {object} [flags] - flags to apply to the group
  * @returns {Group} root group
- * @fires QueryBuilder#afterAddGroup
+ * @fires QueryBuilder.afterAddGroup
  */
 QueryBuilder.prototype.setRoot = function(addRule, data, flags) {
     addRule = (addRule === undefined || addRule === true);
@@ -354,8 +354,8 @@ QueryBuilder.prototype.setRoot = function(addRule, data, flags) {
  * @param {object} [data] - group custom data
  * @param {object} [flags] - flags to apply to the group
  * @returns {Group}
- * @fires QueryBuilder#beforeAddGroup
- * @fires QueryBuilder#afterAddGroup
+ * @fires QueryBuilder.beforeAddGroup
+ * @fires QueryBuilder.afterAddGroup
  */
 QueryBuilder.prototype.addGroup = function(parent, addRule, data, flags) {
     addRule = (addRule === undefined || addRule === true);
@@ -403,8 +403,8 @@ QueryBuilder.prototype.addGroup = function(parent, addRule, data, flags) {
  * Tries to delete a group. The group is not deleted if at least one rule is flagged `no_delete`.
  * @param {Group} group
  * @returns {boolean} if the group has been deleted
- * @fires QueryBuilder#beforeDeleteGroup
- * @fires QueryBuilder#afterDeleteGroup
+ * @fires QueryBuilder.beforeDeleteGroup
+ * @fires QueryBuilder.afterDeleteGroup
  */
 QueryBuilder.prototype.deleteGroup = function(group) {
     if (group.isRoot()) {
@@ -447,7 +447,7 @@ QueryBuilder.prototype.deleteGroup = function(group) {
 /**
  * Performs actions when a group's condition changes
  * @param {Group} group
- * @fires QueryBuilder#afterUpdateGroupCondition
+ * @fires QueryBuilder.afterUpdateGroupCondition
  * @private
  */
 QueryBuilder.prototype.updateGroupCondition = function(group) {
@@ -489,9 +489,9 @@ QueryBuilder.prototype.refreshGroupsConditions = function() {
  * @param {object} [data] - rule custom data
  * @param {object} [flags] - flags to apply to the rule
  * @returns {Rule}
- * @fires QueryBuilder#beforeAddRule
- * @fires QueryBuilder#afterAddRule
- * @fires QueryBuilder#changer:getDefaultFilter
+ * @fires QueryBuilder.beforeAddRule
+ * @fires QueryBuilder.afterAddRule
+ * @fires QueryBuilder.changer:getDefaultFilter
  */
 QueryBuilder.prototype.addRule = function(parent, data, flags) {
     /**
@@ -547,8 +547,8 @@ QueryBuilder.prototype.addRule = function(parent, data, flags) {
  * Tries to delete a rule
  * @param {Rule} rule
  * @returns {boolean} if the rule has been deleted
- * @fires QueryBuilder#beforeDeleteRule
- * @fires QueryBuilder#afterDeleteRule
+ * @fires QueryBuilder.beforeDeleteRule
+ * @fires QueryBuilder.afterDeleteRule
  */
 QueryBuilder.prototype.deleteRule = function(rule) {
     if (rule.flags.no_delete) {
@@ -581,8 +581,8 @@ QueryBuilder.prototype.deleteRule = function(rule) {
 /**
  * Creates the filters for a rule
  * @param {Rule} rule
- * @fires QueryBuilder#changer:getRuleFilters
- * @fires QueryBuilder#afterCreateRuleFilters
+ * @fires QueryBuilder.changer:getRuleFilters
+ * @fires QueryBuilder.afterCreateRuleFilters
  * @private
  */
 QueryBuilder.prototype.createRuleFilters = function(rule) {
@@ -611,7 +611,7 @@ QueryBuilder.prototype.createRuleFilters = function(rule) {
 /**
  * Creates the operators for a rule and init the rule operator
  * @param {Rule} rule
- * @fires QueryBuilder#afterCreateRuleOperators
+ * @fires QueryBuilder.afterCreateRuleOperators
  * @private
  */
 QueryBuilder.prototype.createRuleOperators = function(rule) {
@@ -642,7 +642,7 @@ QueryBuilder.prototype.createRuleOperators = function(rule) {
 /**
  * Creates the main input for a rule
  * @param {Rule} rule
- * @fires QueryBuilder#afterCreateRuleInput
+ * @fires QueryBuilder.afterCreateRuleInput
  * @private
  */
 QueryBuilder.prototype.createRuleInput = function(rule) {
@@ -701,7 +701,7 @@ QueryBuilder.prototype.createRuleInput = function(rule) {
  * Performs action when a rule's filter changes
  * @param {Rule} rule
  * @param {object} previousFilter
- * @fires QueryBuilder#afterUpdateRuleFilter
+ * @fires QueryBuilder.afterUpdateRuleFilter
  * @private
  */
 QueryBuilder.prototype.updateRuleFilter = function(rule, previousFilter) {
@@ -728,7 +728,7 @@ QueryBuilder.prototype.updateRuleFilter = function(rule, previousFilter) {
  * Performs actions when a rule's operator changes
  * @param {Rule} rule
  * @param {object} previousOperator
- * @fires QueryBuilder#afterUpdateRuleOperator
+ * @fires QueryBuilder.afterUpdateRuleOperator
  * @private
  */
 QueryBuilder.prototype.updateRuleOperator = function(rule, previousOperator) {
@@ -768,7 +768,7 @@ QueryBuilder.prototype.updateRuleOperator = function(rule, previousOperator) {
 /**
  * Performs actions when rule's value changes
  * @param {Rule} rule
- * @fires QueryBuilder#afterUpdateRuleValue
+ * @fires QueryBuilder.afterUpdateRuleValue
  * @private
  */
 QueryBuilder.prototype.updateRuleValue = function(rule) {
@@ -788,7 +788,7 @@ QueryBuilder.prototype.updateRuleValue = function(rule) {
 /**
  * Changes a rule's properties depending on its flags
  * @param {Rule} rule
- * @fires QueryBuilder#afterApplyRuleFlags
+ * @fires QueryBuilder.afterApplyRuleFlags
  * @private
  */
 QueryBuilder.prototype.applyRuleFlags = function(rule) {
@@ -820,7 +820,7 @@ QueryBuilder.prototype.applyRuleFlags = function(rule) {
 /**
  * Changes group's properties depending on its flags
  * @param {Group} group
- * @fires QueryBuilder#afterApplyGroupFlags
+ * @fires QueryBuilder.afterApplyGroupFlags
  * @private
  */
 QueryBuilder.prototype.applyGroupFlags = function(group) {
@@ -875,7 +875,7 @@ QueryBuilder.prototype.clearErrors = function(node) {
 /**
  * Adds/Removes error on a Rule or Group
  * @param {Node} node
- * @fires QueryBuilder#changer:displayError
+ * @fires QueryBuilder.changer:displayError
  * @private
  */
 QueryBuilder.prototype.updateError = function(node) {
@@ -910,7 +910,7 @@ QueryBuilder.prototype.updateError = function(node) {
  * @param {Node} node
  * @param {string|array} error
  * @param {*} value
- * @fires QueryBuilder#validationError
+ * @fires QueryBuilder.validationError
  * @private
  */
 QueryBuilder.prototype.triggerValidationError = function(node, error, value) {

src/data.js

@@ -3,7 +3,7 @@
  * @param {Rule} rule
  * @param {string|string[]} value
  * @returns {array|boolean} true or error array
- * @fires QueryBuilder#changer:validateValue
+ * @fires QueryBuilder.changer:validateValue
  */
 QueryBuilder.prototype.validateValue = function(rule, value) {
     var validation = rule.filter.validation || {};
@@ -246,7 +246,7 @@ QueryBuilder.prototype.nextRuleId = function() {
  * Returns the operators for a filter
  * @param {string|object} filter - filter id or filter object
  * @returns {object[]}
- * @fires QueryBuilder#changer:getOperators
+ * @fires QueryBuilder.changer:getOperators
  * @private
  */
 QueryBuilder.prototype.getOperators = function(filter) {
@@ -341,7 +341,7 @@ QueryBuilder.prototype.getOperatorByType = function(type, doThrow) {
  * Returns rule's current input value
  * @param {Rule} rule
  * @returns {*}
- * @fires QueryBuilder#changer:getRuleValue
+ * @fires QueryBuilder.changer:getRuleValue
  * @private
  */
 QueryBuilder.prototype.getRuleInputValue = function(rule) {
@@ -483,7 +483,7 @@ QueryBuilder.prototype.setRuleInputValue = function(rule, value) {
  * Parses rule flags
  * @param {object} rule
  * @returns {object}
- * @fires QueryBuilder#changer:parseRuleFlags
+ * @fires QueryBuilder.changer:parseRuleFlags
  * @private
  */
 QueryBuilder.prototype.parseRuleFlags = function(rule) {
@@ -539,7 +539,7 @@ QueryBuilder.prototype.getRuleFlags = function(flags, all) {
  * Parses group flags
  * @param {object} group
  * @returns {object}
- * @fires QueryBuilder#changer:parseGroupFlags
+ * @fires QueryBuilder.changer:parseGroupFlags
  * @private
  */
 QueryBuilder.prototype.parseGroupFlags = function(group) {
@@ -596,7 +596,7 @@ QueryBuilder.prototype.getGroupFlags = function(flags, all) {
  * @param {string} [category]
  * @param {string|object} key
  * @returns {string}
- * @fires QueryBuilder#changer:translate
+ * @fires QueryBuilder.changer:translate
  */
 QueryBuilder.prototype.translate = function(category, key) {
     if (!key) {

src/defaults.js

@@ -2,6 +2,7 @@
  * Allowed types and their internal representation
  * @type {object.<string, string>}
  * @readonly
+ * @private
  */
 QueryBuilder.types = {
     'string':   'string',
@@ -17,6 +18,7 @@ QueryBuilder.types = {
  * Allowed inputs
  * @type {string[]}
  * @readonly
+ * @private
  */
 QueryBuilder.inputs = [
     'text',
@@ -31,6 +33,7 @@ QueryBuilder.inputs = [
  * Runtime modifiable options with `setOptions` method
  * @type {string[]}
  * @readonly
+ * @private
  */
 QueryBuilder.modifiable_options = [
     'display_errors',

src/jquery.js

@@ -9,6 +9,11 @@
  * @memberof external:"jQuery.fn"
  * @param {*} option - initial configuration or method name
  * @param {...*} args - method arguments
+ *
+ * @example
+ * $('#builder').queryBuilder({ /** configuration object *\/ });
+ * @example
+ * $('#builder').queryBuilder('methodName', methodParam1, methodParam2);
  */
 $.fn.queryBuilder = function(option) {
     if (this.length === 0) {

src/main.js

@@ -14,7 +14,7 @@
  * @param {jQuery} $el
  * @param {object} options - see {@link http://querybuilder.js.org/#options}
  * @constructor
- * @fires QueryBuilder#afterInit
+ * @fires QueryBuilder.afterInit
  */
 var QueryBuilder = function($el, options) {
     $el[0].queryBuilder = this;
@@ -237,52 +237,3 @@ $.extend(QueryBuilder.prototype, /** @lends QueryBuilder.prototype */ {
         }).join(' ');
     }
 });
-
-/**
- * Definition of available plugins
- * @type {object.<String, object>}
- */
-QueryBuilder.plugins = {};
-
-/**
- * Gets or extends the default configuration
- * @param {object} [options] - new configuration
- * @returns {undefined|object} nothing or configuration object (copy)
- */
-QueryBuilder.defaults = function(options) {
-    if (typeof options == 'object') {
-        $.extendext(true, 'replace', QueryBuilder.DEFAULTS, options);
-    }
-    else if (typeof options == 'string') {
-        if (typeof QueryBuilder.DEFAULTS[options] == 'object') {
-            return $.extend(true, {}, QueryBuilder.DEFAULTS[options]);
-        }
-        else {
-            return QueryBuilder.DEFAULTS[options];
-        }
-    }
-    else {
-        return $.extend(true, {}, QueryBuilder.DEFAULTS);
-    }
-};
-
-/**
- * Registers a new plugin
- * @param {string} name
- * @param {function} fct - init function
- * @param {object} [def] - default options
- */
-QueryBuilder.define = function(name, fct, def) {
-    QueryBuilder.plugins[name] = {
-        fct: fct,
-        def: def || {}
-    };
-};
-
-/**
- * Adds new methods to QueryBuilder prototype
- * @param {object.<string, function>} methods
- */
-QueryBuilder.extend = function(methods) {
-    $.extend(QueryBuilder.prototype, methods);
-};