8
0
Просмотр исходного кода

Fixed part of errors thrown by "gulp docs".

Kamil Piechaczek 8 лет назад
Родитель
Сommit
2fee16d4a2

+ 6 - 6
packages/ckeditor5-core/src/plugin.js

@@ -55,7 +55,7 @@ mix( Plugin, ObservableMixin );
 /**
  * The base interface for CKEditor plugins.
  *
- * @interface Plugin
+ * @interface PluginInterface
  */
 
 /**
@@ -78,7 +78,7 @@ mix( Plugin, ObservableMixin );
 
 /**
  * Optional name of the plugin. If set, the plugin will be available in
- * {@link module:core/plugincollectioncollection~PluginCollection#get} by its
+ * {@link module:core/plugincollection~PluginCollection#get} by its
  * name and its constructor. If not, then only by its constructor.
  *
  * The name should reflect the package name + the plugin module name. E.g. `ckeditor5-image/src/image.js` plugin
@@ -117,7 +117,7 @@ mix( Plugin, ObservableMixin );
  * {@link #afterInit} servers for the special "after init" scenarios (e.g. code which depends on other
  * plugins, but which doesn't {@link module:core/plugin~PluginInterface.requires explicitly require} them).
  *
- * @method constructor
+ * @method #constructor
  * @param {module:core/editor/editor~Editor} editor
  */
 
@@ -128,20 +128,20 @@ mix( Plugin, ObservableMixin );
  * A plugin's `init()` method is called after its {@link module:core/plugin~PluginInterface.requires dependencies} are initialized,
  * so in the same order as constructors of these plugins.
  *
- * @method init
+ * @method #init
  * @returns {null|Promise}
  */
 
 /**
  * The third (and last) stage of plugin initialization. See also {@link #constructor} and {@link #init}.
  *
- * @method afterInit
+ * @method #afterInit
  * @returns {null|Promise}
  */
 
 /**
  * Destroys the plugin.
  *
- * @method destroy
+ * @method #destroy
  * @returns {null|Promise}
  */

+ 8 - 8
packages/ckeditor5-core/src/plugincollection.js

@@ -21,7 +21,7 @@ export default class PluginCollection {
 	 *
 	 * @param {module:core/editor/editor~Editor} editor
 	 * @param {Array.<Function>} [availablePlugins] Plugins (constructors) which the collection will be able to use
-	 * when {@link module:core/plugin~PluginCollection#load} is used with plugin names (strings, instead of constructors).
+	 * when {@link module:core/plugincollection~PluginCollection#load} is used with plugin names (strings, instead of constructors).
 	 * Usually, the editor will pass its built-in plugins to the collection so they can later be
 	 * used in `config.plugins` or `config.removePlugins` by names.
 	 */
@@ -69,8 +69,8 @@ export default class PluginCollection {
 	/**
 	 * Gets the plugin instance by its constructor or name.
 	 *
-	 * @param {Function|String} key The plugin constructor or {@link module:core/plugin~Plugin.pluginName name}.
-	 * @returns {module:core/plugin~Plugin}
+	 * @param {Function|String} key The plugin constructor or {@link module:core/plugin~PluginInterface.pluginName name}.
+	 * @returns {module:core/plugin~PluginInterface}
 	 */
 	get( key ) {
 		return this._plugins.get( key );
@@ -79,14 +79,14 @@ export default class PluginCollection {
 	/**
 	 * Loads a set of plugins and adds them to the collection.
 	 *
-	 * @param {Array.<Function|String>} plugins An array of {@link module:core/plugin~Plugin plugin constructors}
-	 * or {@link module:core/plugin~Plugin.pluginName plugin names}. The second option (names) work only if
+	 * @param {Array.<Function|String>} plugins An array of {@link module:core/plugin~PluginInterface plugin constructors}
+	 * or {@link module:core/plugin~PluginInterface.pluginName plugin names}. The second option (names) work only if
 	 * `availablePlugins` were passed to the {@link #constructor}.
 	 * @param {Array.<String|Function>} [removePlugins] Names of plugins or plugin constructors
 	 * which should not be loaded (despite being specified in the `plugins` array).
 	 * @returns {Promise} A promise which gets resolved once all plugins are loaded and available into the
 	 * collection.
-	 * @returns {Promise.<Array.<module:core/plugin~Plugin>>} returns.loadedPlugins The array of loaded plugins.
+	 * @returns {Promise.<Array.<module:core/plugin~PluginInterface>>} returns.loadedPlugins The array of loaded plugins.
 	 */
 	load( plugins, removePlugins = [] ) {
 		const that = this;
@@ -194,7 +194,7 @@ export default class PluginCollection {
 		function assertIsPlugin( PluginConstructor ) {
 			if ( !( PluginConstructor.prototype instanceof Plugin ) ) {
 				/**
-				 * The loaded plugin module is not an instance of {@link module:core/plugin~Plugin}.
+				 * The loaded plugin module is not an instance of {@link module:core/plugin~PluginInterface}.
 				 *
 				 * @error plugincollection-instance
 				 * @param {*} plugin The constructor which is meant to be loaded as a plugin.
@@ -230,7 +230,7 @@ export default class PluginCollection {
 	 *
 	 * @protected
 	 * @param {Function} PluginConstructor The plugin constructor.
-	 * @param {module:core/plugin~Plugin} plugin The instance of the plugin.
+	 * @param {module:core/plugin~PluginInterface} plugin The instance of the plugin.
 	 */
 	_add( PluginConstructor, plugin ) {
 		this._plugins.set( PluginConstructor, plugin );