Browse Source

API docs fixes.

Maciej Bukowski 6 years ago
parent
commit
a7d1ecf853
1 changed files with 4 additions and 1 deletions
  1. 4 1
      packages/ckeditor5-engine/src/view/view.js

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

@@ -403,9 +403,12 @@ export default class View {
 	}
 
 	/**
-	 * Renders {@link module:engine/view/document~Document view document} to DOM. If any view changes are
+	 * Forces rendering {@link module:engine/view/document~Document view document} to DOM. If any view changes are
 	 * currently in progress, rendering will start after all {@link #change change blocks} are processed.
 	 *
+	 * Note that this method is dedicated for special cases. All view changes should be wrapped in the {@link #change}
+	 * block and the view will automatically check whether it needs to render DOM or not.
+	 *
 	 * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when
 	 * trying to re-render when rendering to DOM has already started.
 	 */