Przeglądaj źródła

Merge pull request #1600 from denisname/doc-typos

Docs: Fix some typos.

Thanks to @denisname!
Piotrek Koszuliński 7 lat temu
rodzic
commit
de999b99bc

+ 1 - 1
packages/ckeditor5-engine/src/dev-utils/view.js

@@ -1053,7 +1053,7 @@ function _convertType( type ) {
 // Checks if a given priority is allowed. Returns null if the priority cannot be converted.
 //
 // @param {String} priorityString
-// returns {Number|Null}
+// returns {Number|null}
 function _convertPriority( priorityString ) {
 	const priority = parseInt( priorityString, 10 );
 

+ 1 - 1
packages/ckeditor5-engine/src/model/node.js

@@ -99,7 +99,7 @@ export default class Node {
 	 * This means that model tree got broken.
 	 *
 	 * @readonly
-	 * @type {Number|Null}
+	 * @type {Number|null}
 	 */
 	get startOffset() {
 		let pos;

+ 2 - 1
packages/ckeditor5-engine/src/model/text.js

@@ -55,7 +55,8 @@ export default class Text extends Node {
 	/**
 	 * Returns a text data contained in the node.
 	 *
-	 * @returns {String}
+	 * @readonly
+	 * @type {String}
 	 */
 	get data() {
 		return this._data;

+ 3 - 3
packages/ckeditor5-engine/src/view/attributeelement.js

@@ -69,7 +69,7 @@ export default class AttributeElement extends Element {
 		 * This property is managed by {@link module:engine/view/downcastwriter~DowncastWriter}.
 		 *
 		 * @protected
-		 * @member {Set|null}
+		 * @member {Set.<module:engine/view/attributeelement~AttributeElement>|null}
 		 */
 		this._clonesGroup = null;
 	}
@@ -78,7 +78,7 @@ export default class AttributeElement extends Element {
 	 * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
 	 *
 	 * @readonly
-	 * @returns {Number}
+	 * @type {Number}
 	 */
 	get priority() {
 		return this._priority;
@@ -89,7 +89,7 @@ export default class AttributeElement extends Element {
 	 * and then two elements are considered similar if, and only if they have the same `id`.
 	 *
 	 * @readonly
-	 * @returns {String|Number}
+	 * @type {String|Number}
 	 */
 	get id() {
 		return this._id;

+ 1 - 1
packages/ckeditor5-engine/src/view/document.js

@@ -40,7 +40,7 @@ export default class Document {
 		 * model root using {@link module:engine/model/document~Document#createRoot}.
 		 *
 		 * @readonly
-		 * @member {Collection} module:engine/view/document~Document#roots
+		 * @member {module:utils/collection~Collection} module:engine/view/document~Document#roots
 		 */
 		this.roots = new Collection( { idProperty: 'rootName' } );
 

+ 2 - 2
packages/ckeditor5-engine/src/view/element.js

@@ -106,7 +106,7 @@ export default class Element extends Node {
 		 * Map of styles.
 		 *
 		 * @protected
-		 * @member {Set} module:engine/view/element~Element#_styles
+		 * @member {Map} module:engine/view/element~Element#_styles
 		 */
 		this._styles = new Map();
 
@@ -121,7 +121,7 @@ export default class Element extends Node {
 		 * Custom properties can be added to element instance, will be cloned but not rendered into DOM.
 		 *
 		 * @protected
-		 * @memeber {Map}
+		 * @member {Map}
 		 */
 		this._customProperties = new Map();
 	}

+ 2 - 0
packages/ckeditor5-engine/src/view/emptyelement.js

@@ -16,6 +16,8 @@ import Node from './node';
  *
  * To create a new empty element use the
  * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement `downcastWriter#createEmptyElement()`} method.
+ *
+ * @extends module:engine/view/element~Element
  */
 export default class EmptyElement extends Element {
 	/**

+ 1 - 1
packages/ckeditor5-engine/src/view/filler.js

@@ -37,7 +37,7 @@ import isText from '@ckeditor/ckeditor5-utils/src/dom/istext';
  */
 
 /**
- * `<br> filler creator. This is a function which creates `<br data-cke-filler="true">` element.
+ * `<br>` filler creator. This is a function which creates `<br data-cke-filler="true">` element.
  * It defines how the filler is created.
  *
  * @see module:engine/view/filler~NBSP_FILLER

+ 2 - 2
packages/ckeditor5-engine/src/view/matcher.js

@@ -364,7 +364,7 @@ function matchStyles( patterns, element ) {
  *
  *		// Match view element which has matching attributes.
  *		const pattern = {
- *			attribute: {
+ *			attributes: {
  *				title: 'foobar',	// Attribute title should equal 'foobar'.
  *				foo: /^\w+/,		// Attribute foo should match /^\w+/ regexp.
  *				bar: true			// Attribute bar should be set (can be empty).
@@ -384,7 +384,7 @@ function matchStyles( patterns, element ) {
  *		// Multiple classes to match.
  *		const pattern = {
  *			classes: [ 'baz', 'bar', /foo.../ ]
- *		}:
+ *		};
  *
  *		// Match view element which has given styles.
  *		const pattern = {

+ 3 - 2
packages/ckeditor5-engine/src/view/text.js

@@ -51,7 +51,8 @@ export default class Text extends Node {
 	/**
 	 * The text content.
 	 *
-	 * @returns {String}
+	 * @readonly
+	 * @type {String}
 	 */
 	get data() {
 		return this._textData;
@@ -69,7 +70,7 @@ export default class Text extends Node {
 	 * If the protected getter didn't exist, `foo._data` will return `undefined` and result of the merge will be invalid.
 	 *
 	 * @protected
-	 * @returns {String}
+	 * @type {String}
 	 */
 	get _data() {
 		return this.data;

+ 6 - 1
packages/ckeditor5-engine/src/view/textproxy.js

@@ -85,7 +85,12 @@ export default class TextProxy {
 	}
 
 	/**
-	 * @inheritDoc
+	 * Offset size of this node.
+	 *
+	 * Read more in {@link module:engine/view/node~Node#offsetSize}.
+	 *
+	 * @readonly
+	 * @type {Number}
 	 */
 	get offsetSize() {
 		return this.data.length;

+ 2 - 0
packages/ckeditor5-engine/src/view/uielement.js

@@ -29,6 +29,8 @@ import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  *
  * To create a new UI element use the
  * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`} method.
+ *
+ * @extends module:engine/view/element~Element
  */
 export default class UIElement extends Element {
 	/**