1 files changed, 79 insertions, 0 deletions
diff --git a/core/plugindefinition.js b/core/plugindefinition.js
new file mode 100644
index 0000000..b0e8944
--- /dev/null
+++ b/core/plugindefinition.js
@@ -0,0 +1,79 @@
+/**
+ * @license Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.html or http://ckeditor.com/license
+ */
+
+/**
+ * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which
+ *		contains the defintion of a plugin. This file is for documentation
+ *		purposes only.
+ */
+
+/**
+ * Virtual class which just illustrates the features of plugin objects to be
+ * passed to the {@link CKEDITOR.plugins#add} method.
+ *
+ * This class is not really part of the API, so don't call its constructor.
+ *
+ * @class CKEDITOR.pluginDefinition
+ * @abstract
+ */
+
+/**
+ * A list of plugins that are required by this plugin. Note that this property
+ * doesn't guarantee the loading order of the plugins.
+ *
+ *		CKEDITOR.plugins.add( 'sample', {
+ *			requires: [ 'button', 'selection' ]
+ *		} );
+ *
+ * @property {Array} requires
+ */
+
+/**
+ * A list of language files available for this plugin. These files are stored inside
+ * the `lang` directory, which is inside the plugin directory, follow the name
+ * pattern of `langCode.js`, and contain a language definition created with
+ * {@link CKEDITOR.plugins#setLang}.
+ *
+ * While the plugin is being loaded, the editor checks this list to see if
+ * a language file of the current editor language ({@link CKEDITOR.editor#langCode})
+ * is available, and if so, loads it. Otherwise, the file represented by the first list item
+ * in the list is loaded.
+ *
+ *		CKEDITOR.plugins.add( 'sample', {
+ *			lang: [ 'en', 'fr' ]
+ *		} );
+ *
+ * @property {Array} lang
+ */
+
+/**
+ * Function called on initialization of every editor instance created in the
+ * page before the `init()` call task. The beforeInit function will be called for
+ * all plugins, after that the init function is called for all of them. This
+ * feature makes it possible to initialize things that could be used in the
+ * init function of other plugins.
+ *
+ *		CKEDITOR.plugins.add( 'sample', {
+ *			beforeInit: function( editor ) {
+ *				alert( 'Editor "' + editor.name + '" is to be initialized!' );
+ *			}
+ *		} );
+ *
+ * @method beforeInit
+ * @param {CKEDITOR.editor} editor The editor instance being initialized.
+ */
+
+/**
+ * Function called on initialization of every editor instance created in the page.
+ *
+ *		CKEDITOR.plugins.add( 'sample', {
+ *			init: function( editor ) {
+ *				alert( 'Editor "' + editor.name + '" is being initialized!' );
+ *			}
+ *		} );
+ *
+ * @method init
+ * @param {CKEDITOR.editor} editor The editor instance being initialized.
+ */