Sfoglia il codice sorgente

API docs improvements.

Maciej Bukowski 7 anni fa
parent
commit
49e52d07a2
1 ha cambiato i file con 3 aggiunte e 3 eliminazioni
  1. 3 3
      packages/ckeditor5-autosave/src/autosave.js

+ 3 - 3
packages/ckeditor5-autosave/src/autosave.js

@@ -14,7 +14,8 @@ import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
 
 /**
  * Autosave plugin provides an easy-to-use API to save the editor's content.
- * It watches `Document:change`, and `Window:beforeunload` events and calls the provider's save method.
+ * It watches {module:engine/model/document~Document#event:change:data change:data}
+ * and `Window:beforeunload` events and calls the provider's save method.
  *
  * 		ClassicEditor
  *			.create( document.querySelector( '#editor' ), {
@@ -30,8 +31,7 @@ import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin';
  *					save() {
  *						const data = editor.getData();
  *
- *						// Note: saveEditorsContentToDatabase function should return a promise
- *						// to pending action or be sync.
+ *						// Note: saveEditorsContentToDatabase function might be async and return a promise to the saving action.
  *						return saveEditorsContentToDatabase( data );
  *					}
  *				};