Procházet zdrojové kódy

Added missing docs.

Kamil Piechaczek před 7 roky
rodič
revize
09d3d58e5a

+ 1 - 0
packages/ckeditor5-engine/src/controller/datacontroller.js

@@ -66,6 +66,7 @@ export default class DataController {
 		 * cleared directly after the data are converted. However, the mapper is defined as a class property, because
 		 * it needs to be passed to the `DowncastDispatcher` as a conversion API.
 		 *
+		 * @readonly
 		 * @member {module:engine/conversion/mapper~Mapper}
 		 */
 		this.mapper = new Mapper();

+ 4 - 0
packages/ckeditor5-engine/src/conversion/conversion.js

@@ -29,6 +29,10 @@ export default class Conversion {
 	 * Creates new Conversion instance.
 	 */
 	constructor() {
+		/**
+		 * @private
+		 * @member {Map}
+		 */
 		this._dispatchersGroups = new Map();
 	}
 

+ 1 - 1
packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js

@@ -36,7 +36,7 @@ export default class HtmlDataProcessor {
 		 * A DOM converter used to convert DOM elements to view elements.
 		 *
 		 * @private
-		 * @member
+		 * @member {module:engine/view/domconverter~DomConverter}
 		 */
 		this._domConverter = new DomConverter( { blockFiller: NBSP_FILLER } );
 

+ 1 - 0
packages/ckeditor5-engine/src/model/documentfragment.js

@@ -38,6 +38,7 @@ export default class DocumentFragment {
 		 * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection}
 		 * when DocumentFragment will be inserted to the document.
 		 *
+		 * @readonly
 		 * @member {Map<String,module:engine/model/range~Range>} module:engine/model/documentfragment~DocumentFragment#markers
 		 */
 		this.markers = new Map();

+ 1 - 0
packages/ckeditor5-engine/src/model/element.js

@@ -40,6 +40,7 @@ export default class Element extends Node {
 		/**
 		 * Element name.
 		 *
+		 * @readonly
 		 * @member {String} module:engine/model/element~Element#name
 		 */
 		this.name = name;

+ 17 - 15
packages/ckeditor5-engine/src/model/model.js

@@ -40,15 +40,6 @@ import getSelectedContent from './utils/getselectedcontent';
 export default class Model {
 	constructor() {
 		/**
-		 * All callbacks added by {@link module:engine/model/model~Model#change} or
-		 * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed.
-		 *
-		 * @private
-		 * @type {Array.<Function>}
-		 */
-		this._pendingChanges = [];
-
-		/**
 		 * Models markers' collection.
 		 *
 		 * @readonly
@@ -59,24 +50,35 @@ export default class Model {
 		/**
 		 * Editors document model.
 		 *
+		 * @readonly
 		 * @member {module:engine/model/document~Document}
 		 */
 		this.document = new Document( this );
 
 		/**
-		 * The last created and currently used writer instance.
+		 * Schema for editors model.
+		 *
+		 * @readonly
+		 * @member {module:engine/model/schema~Schema}
+		 */
+		this.schema = new Schema();
+
+		/**
+		 * All callbacks added by {@link module:engine/model/model~Model#change} or
+		 * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed.
 		 *
 		 * @private
-		 * @member {module:engine/model/writer~Writer}
+		 * @type {Array.<Function>}
 		 */
-		this._currentWriter = null;
+		this._pendingChanges = [];
 
 		/**
-		 * Schema for editors model.
+		 * The last created and currently used writer instance.
 		 *
-		 * @member {module:engine/model/schema~Schema}
+		 * @private
+		 * @member {module:engine/model/writer~Writer}
 		 */
-		this.schema = new Schema();
+		this._currentWriter = null;
 
 		[ 'insertContent', 'deleteContent', 'modifySelection', 'getSelectedContent', 'applyOperation' ]
 			.forEach( methodName => this.decorate( methodName ) );

+ 1 - 0
packages/ckeditor5-engine/src/model/nodelist.js

@@ -19,6 +19,7 @@ export default class NodeList {
 	/**
 	 * Creates an empty node list.
 	 *
+	 * @protected
 	 * @param {Iterable.<module:engine/model/node~Node>} nodes Nodes contained in this node list.
 	 */
 	constructor( nodes ) {

+ 1 - 0
packages/ckeditor5-engine/src/model/position.js

@@ -104,6 +104,7 @@ export default class Position {
 		 *		     |- LI
 		 *		        |- b^a|r  ^ has path: [ 1, 1, 1 ]   | has path: [ 1, 1, 2 ]
 		 *
+		 * @readonly
 		 * @member {Array.<Number>} module:engine/model/position~Position#path
 		 */
 		this.path = path;

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

@@ -64,6 +64,7 @@ export default class DomConverter {
 		/**
 		 * Tag names of DOM `Element`s which are considered pre-formatted elements.
 		 *
+		 * @readonly
 		 * @member {Array.<String>} module:engine/view/domconverter~DomConverter#preElements
 		 */
 		this.preElements = [ 'pre' ];
@@ -71,6 +72,7 @@ export default class DomConverter {
 		/**
 		 * Tag names of DOM `Element`s which are considered block elements.
 		 *
+		 * @readonly
 		 * @member {Array.<String>} module:engine/view/domconverter~DomConverter#blockElements
 		 */
 		this.blockElements = [ 'p', 'div', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6' ];

+ 4 - 0
packages/ckeditor5-engine/src/view/matcher.js

@@ -19,6 +19,10 @@ export default class Matcher {
 	 * more information.
 	 */
 	constructor( ...pattern ) {
+		/**
+		 * @private
+		 * @type {Array<String|RegExp|Object>}
+		 */
 		this._patterns = [];
 
 		this.add( ...pattern );

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

@@ -27,6 +27,7 @@ export default class Position {
 		/**
 		 * Position parent.
 		 *
+		 * @readonly
 		 * @member {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment}
 		 * module:engine/view/position~Position#parent
 		 */
@@ -35,6 +36,7 @@ export default class Position {
 		/**
 		 * Position offset.
 		 *
+		 * @readonly
 		 * @member {Number} module:engine/view/position~Position#offset
 		 */
 		this.offset = offset;

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

@@ -26,6 +26,7 @@ export default class Range {
 		/**
 		 * Start position.
 		 *
+		 * @readonly
 		 * @member {module:engine/view/position~Position}
 		 */
 		this.start = Position.createFromPosition( start );
@@ -33,6 +34,7 @@ export default class Range {
 		/**
 		 * End position.
 		 *
+		 * @readonly
 		 * @member {module:engine/view/position~Position}
 		 */
 		this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start );

+ 1 - 0
packages/ckeditor5-engine/src/view/renderer.js

@@ -43,6 +43,7 @@ export default class Renderer {
 		/**
 		 * Set of DOM Documents instances.
 		 *
+		 * @readonly
 		 * @member {Set.<Document>}
 		 */
 		this.domDocuments = new Set();

+ 1 - 0
packages/ckeditor5-engine/src/view/rooteditableelement.js

@@ -31,6 +31,7 @@ export default class RootEditableElement extends EditableElement {
 		 * Name of this root inside {@link module:engine/view/document~Document} that is an owner of this root. If no
 		 * other name is set, `main` name is used.
 		 *
+		 * @readonly
 		 * @member {String}
 		 */
 		this.rootName = 'main';

+ 4 - 0
packages/ckeditor5-engine/src/view/writer.js

@@ -27,6 +27,10 @@ import EditableElement from './editableelement';
  */
 export default class Writer {
 	constructor( document ) {
+		/**
+		 * @readonly
+		 * @type {module:engine/view/document~Document}
+		 */
 		this.document = document;
 	}