Przeglądaj źródła

API docs corrections for classic editor.

Anna Tomanek 9 lat temu
rodzic
commit
ad65e59264

+ 1 - 1
packages/ckeditor5-editor-classic/CONTRIBUTING.md

@@ -1,4 +1,4 @@
 Contributing
 ========================================
 
-Information about contributing can be found at the following page: <https://github.com/ckeditor/ckeditor5/blob/master/CONTRIBUTING.md>.
+Information about contributing can be found on the following page: <https://github.com/ckeditor/ckeditor5/blob/master/CONTRIBUTING.md>.

+ 1 - 1
packages/ckeditor5-editor-classic/README.md

@@ -3,7 +3,7 @@ Classic Editor
 
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-editor-classic/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-editor-classic#info=devDependencies)
 
-Classic Editor for CKEditor 5. More information about the project can be found at the following url: <https://github.com/ckeditor/ckeditor5-editor-classic>.
+Classic Editor for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-editor-classic>.
 
 ## License
 

+ 5 - 5
packages/ckeditor5-editor-classic/src/classic.js

@@ -25,7 +25,7 @@ export default class ClassicEditor extends StandardEditor {
 	 *
 	 * @param {HTMLElement} element The DOM element that will be the source for the created editor.
 	 * The data will be loaded from it and loaded back to it once the editor is destroyed.
-	 * @param {Object} config The editor config.
+	 * @param {Object} config The editor configuration.
 	 */
 	constructor( element, config ) {
 		super( element, config );
@@ -40,7 +40,7 @@ export default class ClassicEditor extends StandardEditor {
 		this.ui.view = new BoxedEditorUIView( this.locale );
 
 		/**
-		 * The element replacer instance used to hide editor element.
+		 * The element replacer instance used to hide the editor element.
 		 *
 		 * @protected
 		 * @member {utils.ElementReplacer} editor-classic.Classic#_elementReplacer
@@ -77,9 +77,9 @@ export default class ClassicEditor extends StandardEditor {
 	 *			console.error( err.stack );
 	 *		} );
 	 *
-	 * @param {HTMLElement} element See {@link ckeditor5.editor.ClassicEditor#constructor}'s param.
-	 * @param {Object} config See {@link ckeditor5.editor.ClassicEditor#constructor}'s param.
-	 * @returns {Promise} Promise resolved once editor is ready.
+	 * @param {HTMLElement} element See {@link ckeditor5.editor.ClassicEditor#constructor}'s parameters.
+	 * @param {Object} config See {@link ckeditor5.editor.ClassicEditor#constructor}'s parameters.
+	 * @returns {Promise} A promise resolved once the editor is ready.
 	 * @returns {ckeditor5.editor.StandardEditor} return.editor The editor instance.
 	 */
 	static create( element, config ) {

+ 2 - 2
packages/ckeditor5-editor-classic/src/classiceditorui.js

@@ -69,7 +69,7 @@ export default class ClassicEditorUI extends BoxedEditorUI {
 	}
 
 	/**
-	 * Creates editor sticky toolbar.
+	 * Creates the sticky toolbar of the editor.
 	 *
 	 * @protected
 	 * @returns {ui.toolbar.Toolbar}
@@ -87,7 +87,7 @@ export default class ClassicEditorUI extends BoxedEditorUI {
 	}
 
 	/**
-	 * Creates editor main editable.
+	 * Creates the main editable of the editor.
 	 *
 	 * @protected
 	 * @returns {ui.editableUI.EditableUI}