Szymon Kupś пре 9 година
родитељ
комит
6615e66830

+ 9 - 4
packages/ckeditor5-image/src/converters.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/converters
+ */
+
 import ViewContainerElement from '../engine/view/containerelement.js';
 import ViewEmptyElement from '../engine/view/emptyelement.js';
 import ModelElement from '../engine/model/element.js';
@@ -61,9 +65,10 @@ export function viewToModelImage() {
 
 /**
  * Returns model to view selection converter. This converter is applied after default selection conversion is made.
- * It creates fake view selection when {@link engine.view.Selection#getSelectedElement} returns instance of image widget.
+ * It creates fake view selection when {@link module:engine/view/selection~Selection#getSelectedElement} returns instance
+ * of image widget.
  *
- * @param {Function} t {@link utils.Locale#t Locale#t function} used to translate default fake selection's label.
+ * @param {Function} t {@link module:utils/locale~Locale#t Locale#t function} used to translate default fake selection's label.
  * @returns {Function}
  */
 export function modelToViewSelection( t ) {
@@ -92,8 +97,8 @@ export function modelToViewSelection( t ) {
  *
  *		<figure class="image"><img src="..." alt="..."></img></figure>
  *
- * @param {engine.model.Element} modelElement
- * @returns {engine.view.ContainerElement}
+ * @param {module:engine/model/element~Element} modelElement
+ * @return {module:engine/view/containerelement~ContainerElement}
  */
 export function modelToViewImage( modelElement ) {
 	const viewImg = new ViewEmptyElement( 'img', {

+ 6 - 3
packages/ckeditor5-image/src/image.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/image
+ */
+
 import Plugin from '../core/plugin.js';
 import ImageEngine from './imageengine.js';
 import Widget from './widget/widget.js';
@@ -10,10 +14,9 @@ import Widget from './widget/widget.js';
 /**
  * The image plugin.
  *
- * Uses {@link image.ImageEngine}.
+ * Uses {@link module:image/imageengine~ImageEngine}.
  *
- * @memberOf image
- * @extends core.Plugin
+ * @extends module:core/plugin~Plugin
  */
 export default class Image extends Plugin {
 	/**

+ 5 - 2
packages/ckeditor5-image/src/imageengine.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/imageengine
+ */
+
 import Plugin from '../core/plugin.js';
 import buildModelConverter from '../engine/conversion/buildmodelconverter.js';
 import WidgetEngine from './widget/widgetengine.js';
@@ -14,8 +18,7 @@ import { toImageWidget } from './utils.js';
  * Registers `image` as a block element in document's schema and allows it to have two attributes: `src` and `alt`.
  * Registers converters for editing and data pipelines.
  *
- * @memberof image
- * @extends core.Plugin.
+ * @extends module:core/plugin~Plugin.
  */
 export default class ImageEngine extends Plugin {
 	/**

+ 10 - 6
packages/ckeditor5-image/src/utils.js

@@ -3,17 +3,21 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/utils
+ */
+
 import { widgetize, isWidget } from './widget/utils.js';
 
 const imageSymbol = Symbol( 'isImage' );
 
 /**
- * Converts given {@link engine.view.Element} to image widget:
- * * adds {@link engine.view.Element#addCustomProperty custom property} allowing to recognize image widget element,
- * * calls {@link image.widget.utils.widgetize widgetize}.
+ * Converts given {@link module:engine/view/element~Element} to image widget:
+ * * adds {@link module:engine/view/element~Element#setCustomProperty custom property} allowing to recognize image widget element,
+ * * calls {@link module:image/widget/utils~widgetize widgetize}.
  *
- * @param {engine.view.Element} viewElement
- * @returns {engine.view.Element}
+ * @param {module:engine/view/element~Element} viewElement
+ * @returns {module:engine/view/element~Element}
  */
 export function toImageWidget( viewElement ) {
 	viewElement.setCustomProperty( imageSymbol, true );
@@ -24,7 +28,7 @@ export function toImageWidget( viewElement ) {
 /**
  * Checks if given view element is an image widget.
  *
- * @param {engine.view.Element} viewElement
+ * @param {module:engine/view/element~Element} viewElement
  * @returns {Boolean}
  */
 export function isImageWidget( viewElement ) {

+ 15 - 12
packages/ckeditor5-image/src/widget/utils.js

@@ -3,27 +3,30 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/widget/utils
+ */
+
 const widgetSymbol = Symbol( 'isWidget' );
 
 /**
- * CSS classes added to each widget element.
+ * CSS class added to each widget element.
  *
- * @member {String} image.widget.utils.WIDGET_CLASS_NAME
+ * @const {String}
  */
 export const WIDGET_CLASS_NAME = 'ck-widget';
 
 /**
- * CSS classes added to currently selected widget element.
+ * CSS class added to currently selected widget element.
  *
- * @member {String} image.widget.utils.WIDGET_SELECTED_CLASS_NAME
+ * @const {String}
  */
 export const WIDGET_SELECTED_CLASS_NAME = 'ck-widget_selected';
 
 /**
- * Returns `true` if given {@link engine.view.Element} is a widget.
+ * Returns `true` if given {@link module:engine/view/element~Element} is a widget.
  *
- * @method image.widget.utils.isWidget
- * @param {engine.view.Element} element
+ * @param {module:engine/view/element~Element} element
  * @returns {Boolean}
  */
 export function isWidget( element ) {
@@ -31,14 +34,14 @@ export function isWidget( element ) {
 }
 
 /**
- * "Widgetizes" given {@link engine.view.Element}:
- * * sets `contenteditable` attribue to `true`,
+ * "Widgetizes" given {@link module:engine/view/element~Element}:
+ * * sets `contenteditable` attribute to `true`,
  * * adds custom `getFillerOffset` method returning `null`,
  * * adds `ck-widget` CSS class,
- * * adds custom property allowing to recognize widget elements by using {@link image.widget.utils.isWidget}.
+ * * adds custom property allowing to recognize widget elements by using {@link ~isWidget}.
  *
- * @param {engine.view.Element} element
- * @returns {engine.view.Element} Returns same element.
+ * @param {module:engine/view/element~Element} element
+ * @returns {module:engine/view/element~Element} Returns same element.
  */
 export function widgetize( element ) {
 	element.setAttribute( 'contenteditable', false );

+ 9 - 6
packages/ckeditor5-image/src/widget/widget.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/widget/widget
+ */
+
 import Plugin from '../../core/plugin.js';
 import WidgetEngine from './widgetengine.js';
 import MouseObserver from '../../engine/view/observer/mouseobserver.js';
@@ -11,10 +15,9 @@ import { isWidget } from './utils.js';
 
 /**
  * The widget plugin.
- * Adds default {@link engine.view.Document#mousedown mousedown} handling on widget elements.
+ * Adds default {@link module:engine/view/document~Document#event:mousedown mousedown} handling on widget elements.
  *
- * @memberOf image.widget
- * @extends core.Plugin.
+ * @extends module:core/plugin~Plugin.
  */
 export default class Widget extends Plugin {
 	/**
@@ -36,11 +39,11 @@ export default class Widget extends Plugin {
 	}
 
 	/**
-	 * Handles {@link engine.view.Document#mousedown mousedown} events on widget elements.
+	 * Handles {@link module:engine/view/document~Document#event:mousedown mousedown} events on widget elements.
 	 *
-	 * @param {utils.EventInfo} eventInfo
-	 * @param {envine.view.observer.DomEventData} domEventData
 	 * @private
+	 * @param {module:utils/eventinfo~EventInfo} eventInfo
+	 * @param {module:engine/view/observer/domeventdata~DomEventData} domEventData
 	 */
 	_onMousedown( eventInfo, domEventData ) {
 		let widgetElement = domEventData.target;

+ 5 - 2
packages/ckeditor5-image/src/widget/widgetengine.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module image/widget/widgetengine
+ */
+
 import Plugin from '../../core/plugin.js';
 import { WIDGET_SELECTED_CLASS_NAME, isWidget } from './utils.js';
 
@@ -12,8 +16,7 @@ import { WIDGET_SELECTED_CLASS_NAME, isWidget } from './utils.js';
  * If converted selection is placed around widget element, selection is marked as fake. Additionally, proper CSS class
  * is added to indicate that widget has been selected.
  *
- * @memberOf image.widget
- * @extends core.Plugin.
+ * @extends module:core/plugin~Plugin.
  */
 export default class WidgetEngine extends Plugin {
 	/**