Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Updated API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ma2ciek committed Oct 23, 2019
1 parent fb188e7 commit 5e3262a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
19 changes: 13 additions & 6 deletions src/dev-utils/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/model/model.js
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit 5e3262a

Please sign in to comment.