8
0
فهرست منبع

Update model/view range docs and tests.

Maciej Gołaszewski 7 سال پیش
والد
کامیت
ae8c2df137

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

@@ -138,7 +138,7 @@ setData._parse = parse;
  *		const b = new Element( 'b', null, text );
  *		const p = new Element( 'p', null, b );
  *		const selection = new Selection(
- *			Range.createFromParentsAndOffsets( p, 0, p, 1 )
+ *			Range._createFromParentsAndOffsets( p, 0, p, 1 )
  *		);
  *
  *		stringify( p, selection ); // '<p>[<b>foobar</b>]</p>'
@@ -148,7 +148,7 @@ setData._parse = parse;
  *		const text = new Text( 'foobar' );
  *		const b = new Element( 'b', null, text );
  *		const p = new Element( 'p', null, b );
- *		const selection = new Selection( Range.createFromParentsAndOffsets( text, 1, text, 5 ) );
+ *		const selection = new Selection( Range._createFromParentsAndOffsets( text, 1, text, 5 ) );
  *
  *		stringify( p, selection ); // '<p><b>f{ooba}r</b></p>'
  *
@@ -161,8 +161,8 @@ setData._parse = parse;
  *
  *		const text = new Text( 'foobar' );
  *		const selection = new Selection( [
- *			Range.createFromParentsAndOffsets( text, 0, text, 1 ) ),
- *			Range.createFromParentsAndOffsets( text, 3, text, 5 ) )
+ *			Range._createFromParentsAndOffsets( text, 0, text, 1 ) ),
+ *			Range._createFromParentsAndOffsets( text, 3, text, 5 ) )
  *		] );
  *
  *		stringify( text, selection ); // '{f}oo{ba}r'
@@ -173,7 +173,7 @@ setData._parse = parse;
  * be converted to a selection containing one range collapsed at this position.
  *
  *		const text = new Text( 'foobar' );
- *		const range = Range.createFromParentsAndOffsets( text, 0, text, 1 );
+ *		const range = Range._createFromParentsAndOffsets( text, 0, text, 1 );
  *		const position = new Position( text, 3 );
  *
  *		stringify( text, range ); // '{f}oobar'

+ 15 - 3
packages/ckeditor5-engine/src/model/liverange.js

@@ -43,7 +43,17 @@ export default class LiveRange extends Range {
 	/**
 	 * @see module:engine/model/range~Range._createIn
 	 * @static
-	 * @method module:engine/model/liverange~LiveRange.createIn
+	 * @protected
+	 * @method module:engine/model/liverange~LiveRange._createIn
+	 * @param {module:engine/model/element~Element} element
+	 * @returns {module:engine/model/liverange~LiveRange}
+	 */
+
+	/**
+	 * @see module:engine/model/range~Range._createOn
+	 * @static
+	 * @protected
+	 * @method module:engine/model/liverange~LiveRange._createOn
 	 * @param {module:engine/model/element~Element} element
 	 * @returns {module:engine/model/liverange~LiveRange}
 	 */
@@ -51,7 +61,8 @@ export default class LiveRange extends Range {
 	/**
 	 * @see module:engine/model/range~Range._createFromPositionAndShift
 	 * @static
-	 * @method module:engine/model/liverange~LiveRange.createFromPositionAndShift
+	 * @protected
+	 * @method module:engine/model/liverange~LiveRange._createFromPositionAndShift
 	 * @param {module:engine/model/position~Position} position
 	 * @param {Number} shift
 	 * @returns {module:engine/model/liverange~LiveRange}
@@ -60,7 +71,8 @@ export default class LiveRange extends Range {
 	/**
 	 * @see module:engine/model/range~Range._createFromRange
 	 * @static
-	 * @method module:engine/model/liverange~LiveRange.createFromRange
+	 * @protected
+	 * @method module:engine/model/liverange~LiveRange._createFromRange
 	 * @param {module:engine/model/range~Range} range
 	 * @returns {module:engine/model/liverange~LiveRange}
 	 */

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

@@ -846,7 +846,7 @@ export default class Range {
 		if ( ranges.length === 0 ) {
 			/**
 			 * At least one range has to be passed to
-			 * {@link module:engine/model/range~Range._createFromRanges `Range.createFromRanges()`}.
+			 * {@link module:engine/model/range~Range._createFromRanges `Range._createFromRanges()`}.
 			 *
 			 * @error range-create-from-ranges-empty-array
 			 */

+ 3 - 3
packages/ckeditor5-engine/tests/model/liverange.js

@@ -67,19 +67,19 @@ describe( 'LiveRange', () => {
 		LiveRange.prototype.stopListening.restore();
 	} );
 
-	it( 'createIn should return LiveRange', () => {
+	it( '_createIn should return LiveRange', () => {
 		const range = LiveRange._createIn( p );
 		expect( range ).to.be.instanceof( LiveRange );
 		range.detach();
 	} );
 
-	it( 'createFromPositionAndShift should return LiveRange', () => {
+	it( '_createFromPositionAndShift should return LiveRange', () => {
 		const range = LiveRange._createFromPositionAndShift( new Position( root, [ 0, 1 ] ), 4 );
 		expect( range ).to.be.instanceof( LiveRange );
 		range.detach();
 	} );
 
-	it( 'createFromRange should return LiveRange', () => {
+	it( '_createFromRange should return LiveRange', () => {
 		const range = LiveRange._createFromRange( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ) );
 		expect( range ).to.be.instanceof( LiveRange );
 		range.detach();

+ 5 - 5
packages/ckeditor5-engine/tests/model/range.js

@@ -155,7 +155,7 @@ describe( 'Range', () => {
 			root._insertChild( 0, [ p ] );
 		} );
 
-		describe( 'createIn()', () => {
+		describe( '_createIn()', () => {
 			it( 'should return range', () => {
 				const range = Range._createIn( p );
 
@@ -164,7 +164,7 @@ describe( 'Range', () => {
 			} );
 		} );
 
-		describe( 'createOn()', () => {
+		describe( '_createOn()', () => {
 			it( 'should return range', () => {
 				const range = Range._createOn( p );
 
@@ -173,7 +173,7 @@ describe( 'Range', () => {
 			} );
 		} );
 
-		describe( 'createFromPositionAndShift()', () => {
+		describe( '_createFromPositionAndShift()', () => {
 			it( 'should make range from start position and offset', () => {
 				const position = new Position( root, [ 1, 2, 3 ] );
 				const range = Range._createFromPositionAndShift( position, 4 );
@@ -185,7 +185,7 @@ describe( 'Range', () => {
 			} );
 		} );
 
-		describe( 'createFromRange()', () => {
+		describe( '_createFromRange()', () => {
 			it( 'should create a new instance of Range that is equal to passed range', () => {
 				const clone = Range._createFromRange( range );
 
@@ -194,7 +194,7 @@ describe( 'Range', () => {
 			} );
 		} );
 
-		describe( 'createFromRanges()', () => {
+		describe( '_createFromRanges()', () => {
 			function makeRanges( root, ...points ) {
 				const ranges = [];