소스 검색

Docs: Improved StandatdEditor and Editor docs.

Oskar Wróbel 8 년 전
부모
커밋
213de30d8b
2개의 변경된 파일7개의 추가작업 그리고 9개의 파일을 삭제
  1. 3 8
      packages/ckeditor5-core/src/editor/editor.js
  2. 4 1
      packages/ckeditor5-core/src/editor/standardeditor.js

+ 3 - 8
packages/ckeditor5-core/src/editor/editor.js

@@ -20,14 +20,9 @@ import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
 import mix from '@ckeditor/ckeditor5-utils/src/mix';
 
 /**
- * Class representing editor. It contains basic editor architecture and provides API needed by plugins
- * like {@link module:engine/controller/editingcontroller~EditingController editing pipeline},
- * {@link module:engine/controller/datacontroller~DataController data pipeline} and
- * {module:core/editingkeystrokehandler~EditingKeystrokeHandler keystroke handler}.
- *
- * Besides it creates main {@link module:engine/model/rootelement~RootElement} using
- * {@link module:engine/model/document~Document#createRoot createRoot} method what automatically creates
- * corresponding {@link module:engine/view/rooteditableelement~RootEditableElement view root} element.
+ * Class representing the base of the editor. It is the API all plugins can expect to get when using editor property.
+ * Editors implementation (like Classic Editor or Inline Editor) should extend this class. They can add their own
+ * methods and properties.
  *
  * See also {@link module:core/editor/standardeditor~StandardEditor}.
  *

+ 4 - 1
packages/ckeditor5-core/src/editor/standardeditor.js

@@ -14,7 +14,10 @@ import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromele
 import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement';
 
 /**
- * Class provides API methods for getting and setting data.
+ * The standard editor class, extending base editor by adding methods needed in the typical
+ * editor implementations: editor with a single editable area created based on the DOM element.
+ * It provides base API to manage data and to integrate the editor with the form when it is
+ * initialized on the textarea element.
  *
  * @extends module:core/editor/editor~Editor
  */