Преглед изворни кода

Docs: Renamed the editor config object.

Piotrek Koszuliński пре 8 година
родитељ
комит
d2e49e2e37

+ 1 - 1
packages/ckeditor5-core/src/editor/editor.js

@@ -197,7 +197,7 @@ export default class Editor {
 	 * Creates a basic editor instance.
 	 *
 	 * @param {Object} config The editor config. You can find the list of config options in
-	 * {@link module:core/editor/configoptions~ConfigOptions}.
+	 * {@link module:core/editor/editorconfig~EditorConfig}.
 	 * @returns {Promise} Promise resolved once editor is ready.
 	 * @returns {module:core/editor/editor~Editor} return.editor The editor instance.
 	 */

+ 7 - 7
packages/ckeditor5-core/src/editor/configoptions.jsdoc → packages/ckeditor5-core/src/editor/editorconfig.jsdoc

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module core/editor/configoptions
+ * @module core/editor/editorconfig
  */
 
 /**
@@ -24,13 +24,13 @@
  *			.then( ... )
  *			.catch( ... );
  *
- * @interface ConfigOptions
+ * @interface EditorConfig
  */
 
 /**
  * The list of plugins to load.
  *
- * If you use an {@link builds/guides/overview editor build} you can define the list of plugins to load
+ * If you use an {@linkTODO builds/guides/overview editor build} you can define the list of plugins to load
  * using names of plugins which are available:
  *
  *		const config = {
@@ -54,17 +54,17 @@
  *			plugins: [ EssentialsPreset, Bold ]
  *		};
  *
- * @member {Array.<String|Function>} module:core/editor/configoptions~ConfigOptions#plugins
+ * @member {Array.<String|Function>} module:core/editor/editorconfig~EditorConfig#plugins
  */
 
 /**
- * The list of plugins which should not be loaded despite being available in an {@link builds/guides/overview editor build}.
+ * The list of plugins which should not be loaded despite being available in an {@linkTODO builds/guides/overview editor build}.
  *
  *		const config = {
  *			removePlugins: [ 'Bold', 'Italic' ]
  *		};
  *
- * @member {Array.<String>} module:core/editor/configoptions~ConfigOptions#removePlugins
+ * @member {Array.<String>} module:core/editor/editorconfig~EditorConfig#removePlugins
  */
 
 /**
@@ -97,5 +97,5 @@
  * Useful when a page with which the editor is being integrated has some other sticky or fixed elements
  * (e.g. the top menu). Thanks to setting the toolbar offset the toolbar won't be positioned underneath or above the page's UI.
  *
- * @member {Object} module:core/editor/configoptions~ConfigOptions#toolbar
+ * @member {Object} module:core/editor/editorconfig~EditorConfig#toolbar
  */

+ 1 - 1
packages/ckeditor5-core/src/editor/standardeditor.js

@@ -108,7 +108,7 @@ export default class StandardEditor extends Editor {
 	 *
 	 * @param {HTMLElement} element See {@link module:core/editor/standardeditor~StandardEditor}'s param.
 	 * @param {Object} config The editor config. You can find the list of config options in
-	 * {@link module:core/editor/configoptions~ConfigOptions}.
+	 * {@link module:core/editor/editorconfig~EditorConfig}.
 	 * @returns {Promise} Promise resolved once editor is ready.
 	 * @returns {module:core/editor/standardeditor~StandardEditor} return.editor The editor instance.
 	 */