소스 검색

Updated API docs.

Maciej Bukowski 6 년 전
부모
커밋
0bfbab5e4c
2개의 변경된 파일14개의 추가작업 그리고 7개의 파일을 삭제
  1. 13 6
      packages/ckeditor5-engine/src/dev-utils/utils.js
  2. 1 1
      packages/ckeditor5-engine/src/model/model.js

+ 13 - 6
packages/ckeditor5-engine/src/dev-utils/utils.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * Note: This package is used only internally for debugging purposes and should not be used
+ * in other environments. It uses a few special methods not existing in the default
+ * building process. That is also why there are no tests for this file.
+ *
  * @module engine/dev-utils/utils
  */
 
@@ -43,14 +47,11 @@ export function convertMapToStringifiedObject( map ) {
 	return JSON.stringify( obj );
 }
 
-/**
- * @private
- */
-export const treeDump = Symbol( '_treeDump' );
+const treeDump = Symbol( '_treeDump' );
 const maxTreeDumpLength = 20;
 
 /**
- * Helper function, stores the `document` state for a given `version` as a string in a private property.
+ * Helper function that stores the `document` state for a given `version`.
  *
  * @private
  * @param {*} document
@@ -74,12 +75,18 @@ export function dumpTrees( document, version ) {
 	}
 }
 
+/**
+ * Helper function that initializes document dumping.
+ *
+ * @private
+ * @param {*} document
+ */
 export function initDocumentDumping( document ) {
 	document[ treeDump ] = [];
 }
 
 /**
- * Helper function that dumps document for the given version.
+ * Helper function that logs document for the given version.
  *
  * @private
  * @param {*} document

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

@@ -302,7 +302,7 @@ export default class Model {
 	 *
 	 *		// Let's create a document fragment containing such content as:
 	 *		//
-	 *		// <paragrap>foo</paragraph>
+	 *		// <paragraph>foo</paragraph>
 	 *		// <blockQuote>
 	 *		//    <paragraph>bar</paragraph>
 	 *		// </blockQuote>