Browse Source

Minor docs fixes and refactoring.

Szymon Kupś 9 years ago
parent
commit
23e899217a

+ 9 - 0
packages/ckeditor5-engine/src/controller/insertcontent.js

@@ -52,9 +52,18 @@ export default function insertContent( dataController, content, selection, batch
 
 	const newRange = insertion.getSelectionRange();
 
+	// We are not testing else because it's a safe check for unpredictable edge cases: an insertion without proper range
+	// to select.
 	/* istanbul ignore else */
 	if ( newRange ) {
 		selection.setRanges( [ newRange ] );
+	} else {
+		/**
+		 * Cannot determine proper range after insertion.
+		 *
+		 * @warning controller-insert-content-no-range
+		 */
+		log.warn( 'controller-insert-content-no-range: Cannot determine proper range after insertion.' );
 	}
 }
 

+ 3 - 3
packages/ckeditor5-engine/src/model/document.js

@@ -292,7 +292,7 @@ export default class Document {
 	 * * `forward` - searching will be performed only forward,
 	 * * `backward` - searching will be performed only backward.
 	 *
-	 * When valid selection range cannot be found, `null` value is returned.
+	 * When valid selection range cannot be found, `null` is returned.
 	 *
 	 * @param {module:engine/model/position~Position} position Reference position where new selection range should be looked for.
 	 * @param {'both'|'forward'|'backward'} [direction='both'] Search direction.
@@ -315,7 +315,7 @@ export default class Document {
 			forwardWalker = new TreeWalker( { startPosition: position } );
 		}
 
-		for ( let data of getWalkersData( backwardWalker, forwardWalker ) ) {
+		for ( let data of combineWalkers( backwardWalker, forwardWalker ) ) {
 			const type = ( data.walker == backwardWalker ? 'elementEnd' : 'elementStart' );
 			const value = data.value;
 
@@ -460,7 +460,7 @@ function validateTextNodePosition( rangeBoundary ) {
 // @param {module:engine/module/treewalker~TreeWalker} [forward] Walker iterating in forward direction.
 // @returns {Iterable.<Object>} Object returned at each iteration contains `value` and `walker` (informing which walker returned
 // given value) fields.
-function *getWalkersData( backward, forward ) {
+function *combineWalkers( backward, forward ) {
 	let done = false;
 
 	while ( !done ) {