Przeglądaj źródła

Reformatted API docs.

Piotrek Koszuliński 9 lat temu
rodzic
commit
496f03b938

+ 9 - 6
packages/ckeditor5-editor-classic/src/classic.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module editor-classic/classic
+ */
+
 import StandardEditor from '../core/editor/standardeditor.js';
 import HtmlDataProcessor from '../engine/dataprocessor/htmldataprocessor.js';
 import ClassicEditorUI from './classiceditorui.js';
@@ -13,8 +17,7 @@ import ElementReplacer from '../utils/elementreplacer.js';
  * Classic editor. Uses inline editable and sticky toolbar, all
  * enclosed in a boxed UI.
  *
- * @memberOf editor-classic
- * @extends core.editor.StandardEditor
+ * @extends module:core/editor/standardeditor~StandardEditor
  */
 export default class ClassicEditor extends StandardEditor {
 	/**
@@ -35,7 +38,7 @@ export default class ClassicEditor extends StandardEditor {
 		 * The element replacer instance used to hide the editor element.
 		 *
 		 * @protected
-		 * @member {utils.ElementReplacer} editor-classic.Classic#_elementReplacer
+		 * @member {module:utils/elementreplacer~ElementReplacer}
 		 */
 		this._elementReplacer = new ElementReplacer();
 	}
@@ -69,10 +72,10 @@ export default class ClassicEditor extends StandardEditor {
 	 *			console.error( err.stack );
 	 *		} );
 	 *
-	 * @param {HTMLElement} element See {@link core.editor.ClassicEditor#constructor}'s parameters.
-	 * @param {Object} config See {@link core.editor.ClassicEditor#constructor}'s parameters.
+	 * @param {HTMLElement} element See {@link module:editor-classic/classic~ClassicEditor#constructor}'s parameters.
+	 * @param {Object} config See {@link module:editor-classic/classic~ClassicEditor#constructor}'s parameters.
 	 * @returns {Promise} A promise resolved once the editor is ready.
-	 * @returns {core.editor.StandardEditor} return.editor The editor instance.
+	 * @returns {module:core/editor/standardeditor~StandardEditor} return.editor The editor instance.
 	 */
 	static create( element, config ) {
 		return new Promise( ( resolve ) => {

+ 11 - 9
packages/ckeditor5-editor-classic/src/classiceditorui.js

@@ -3,27 +3,29 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module editor-classic/classiceditorui
+ */
+
 import ComponentFactory from '../ui/componentfactory.js';
 import FocusTracker from '../utils/focustracker.js';
 
 /**
  * The classic editor UI class.
- *
- * @memberOf editor-classic
  */
 export default class ClassicEditorUI {
 	/**
 	 * Creates an instance of the editor UI class.
 	 *
-	 * @param {core.editor.Editor} editor The editor instance.
-	 * @param {ui.editorUI.EditorUIView} view View of the ui.
+	 * @param {module:core/editor/editor~Editor} editor The editor instance.
+	 * @param {module:ui/editorui/editoruiview~EditorUIView} view View of the ui.
 	 */
 	constructor( editor, view ) {
 		/**
 		 * Editor that the UI belongs to.
 		 *
 		 * @readonly
-		 * @member {core.editor.Editor} editor-classic.ClassicEditorUI#editor
+		 * @member {module:core/editor/editor~Editor}
 		 */
 		this.editor = editor;
 
@@ -31,15 +33,15 @@ export default class ClassicEditorUI {
 		 * View of the ui.
 		 *
 		 * @readonly
-		 * @member {ui.editorUI.EditorUIView} editor-classic.ClassicEditorUI#view
+		 * @member {module:ui/editorui/editoruiview~EditorUIView}
 		 */
 		this.view = view;
 
 		/**
-		 * Instance of the {@link ui.ComponentFactory}.
+		 * Instance of the {@link module:ui/componentfactory~ComponentFactory}.
 		 *
 		 * @readonly
-		 * @member {ui.ComponentFactory} editor-classic.ClassicEditorUI#componentFactory
+		 * @member {module:ui/componentfactory~ComponentFactory}
 		 */
 		this.componentFactory = new ComponentFactory( editor );
 
@@ -47,7 +49,7 @@ export default class ClassicEditorUI {
 		 * Keeps information about editor focus.
 		 *
 		 * @readonly
-		 * @member {utils.FocusTracker} editor-classic.ClassicEditorUI#focusTracker
+		 * @member {module:utils/focustracker~FocusTracker}
 		 */
 		this.focusTracker = new FocusTracker();
 

+ 8 - 5
packages/ckeditor5-editor-classic/src/classiceditoruiview.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module editor-classic/classiceditoruiview
+ */
+
 import BoxedEditorUIView from '../ui/editorui/boxed/boxededitoruiview.js';
 import InlineEditableUIView from '../ui/editableui/inline/inlineeditableuiview.js';
 import StickyToolbarView from '../ui/toolbar/sticky/stickytoolbarview.js';
@@ -11,14 +15,13 @@ import StickyToolbarView from '../ui/toolbar/sticky/stickytoolbarview.js';
  * Classic editor UI view. Uses inline editable and sticky toolbar, all
  * enclosed in a boxed UI view.
  *
- * @memberOf editor-classic
- * @extends ui.editorUI.boxed.BoxedEditorUIView
+ * @extends module:ui/editorui/boxed/boxededitoruiview~BoxedEditorUIView
  */
 export default class ClassicEditorUIView extends BoxedEditorUIView {
 	/**
 	 * Creates an instance of the classic editor UI view.
 	 *
-	 * @param {utils.Locale} locale The {@link core.editor.Editor#locale} instance.
+	 * @param {module:utils/locale~Locale} locale The {@link module:core/editor/editor~Editor#locale} instance.
 	 */
 	constructor( locale ) {
 		super( locale );
@@ -27,7 +30,7 @@ export default class ClassicEditorUIView extends BoxedEditorUIView {
 		 * A sticky toolbar view instance.
 		 *
 		 * @readonly
-		 * @member {ui.toolbar.sticky.StickyToolbarView} editor-classic.ClassicEditorUIView#toolbar
+		 * @member {module:ui/toolbar/sticky/stickytoolbarview~StickyToolbarView}
 		 */
 		this.toolbar = new StickyToolbarView( locale );
 
@@ -35,7 +38,7 @@ export default class ClassicEditorUIView extends BoxedEditorUIView {
 		 * Editable UI view.
 		 *
 		 * @readonly
-		 * @member {ui.editableUI.inline.InlineEditableUIView} editor-classic.ClassicEditorUIView#editable
+		 * @member {module:ui/editableui/inline/inlineeditableuiview~InlineEditableUIView}
 		 */
 		this.editable = new InlineEditableUIView( locale );