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

Commit

Permalink
Docs: Addressed several API documentation issues in the `DecoupledEdi…
Browse files Browse the repository at this point in the history
…tor` class. Closes #37.

Thanks https://github.com/ysct!
  • Loading branch information
oleq committed Jul 19, 2019
2 parents ed3dd65 + 4e77c9a commit 24bee4c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/decouplededitor.js
Expand Up @@ -152,7 +152,7 @@ export default class DecoupledEditor extends Editor {
* document.body.appendChild( editor.ui.view.toolbar.element );
*
* // Initial data was provided so the editor UI element needs to be added manually to the DOM.
* document.body.appendChild( editor.ui.element );
* document.body.appendChild( editor.ui.getEditableElement() );
* } )
* .catch( err => {
* console.error( err.stack );
Expand Down Expand Up @@ -207,7 +207,8 @@ export default class DecoupledEditor extends Editor {
* Moreover, the editor data will be set back to the original element once the editor is destroyed.
*
* If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
* It is available under the {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#element `editor.ui.element`} property.
* It is available via
* {@link module:editor-decoupled/decouplededitorui~DecoupledEditorUI#getEditableElement `editor.ui.getEditableElement()`}.
*
* @param {module:core/editor/editorconfig~EditorConfig} [config] The editor configuration.
* @returns {Promise} A promise resolved once the editor is ready. The promise resolves with the created editor instance.
Expand Down

0 comments on commit 24bee4c

Please sign in to comment.