Browse Source

Docs: Improved links between API and guides. See ckeditor/ckeditor5#1090.

Piotrek Koszuliński 7 years ago
parent
commit
1d6468a147

+ 1 - 1
packages/ckeditor5-image/docs/api/image.md

@@ -10,7 +10,7 @@ This package implements the image feature for CKEditor 5. The feature is introdu
 
 ## Documentation
 
-See the {@link features/image Image feature} guide and the documentation for the following plugins:
+See the {@link features/image Image feature} guide and the documentation of the following plugins:
 
 * {@link module:image/image~Image}
 * {@link module:image/imagecaption~ImageCaption}

+ 8 - 2
packages/ckeditor5-image/src/image.js

@@ -17,10 +17,16 @@ import '../theme/image.css';
 /**
  * The image plugin.
  *
- * Uses the {@link module:image/image/imageediting~ImageEditing}.
- *
  * For a detailed overview, check the {@glink features/image image feature} documentation.
  *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/image/imageediting~ImageEditing},
+ * * {@link module:image/imagetextalternative~ImageTextAlternative}.
+ *
+ * Usually, it is used in conjuction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class Image extends Plugin {

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

@@ -14,11 +14,11 @@ import ImageStyleUI from './imagestyle/imagestyleui';
 /**
  * The image style plugin.
  *
- * It loads the {@link module:image/imagestyle/imagestyleediting~ImageStyleEditing}
- * and {@link module:image/imagestyle/imagestyleui~ImageStyleUI} plugins.
- *
  * For a detailed overview, check the {@glink features/image#image-styles image styles} documentation.
  *
+ * This is a "glue" plugin which loads the {@link module:image/imagestyle/imagestyleediting~ImageStyleEditing}
+ * and {@link module:image/imagestyle/imagestyleui~ImageStyleUI} plugins.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class ImageStyle extends Plugin {

+ 4 - 1
packages/ckeditor5-image/src/imagetextalternative.js

@@ -14,7 +14,10 @@ import ImageTextAlternativeUI from './imagetextalternative/imagetextalternativeu
 /**
  * The image text alternative plugin.
  *
- * It loads the {@link module:image/imagetextalternative/imagetextalternativeediting~ImageTextAlternativeEditing}
+ * For a detailed overview, check the {@glink features/image#image-styles image styles} documentation.
+ *
+ * This is a "glue" plugin which loads the
+ *  {@link module:image/imagetextalternative/imagetextalternativeediting~ImageTextAlternativeEditing}
  * and {@link module:image/imagetextalternative/imagetextalternativeui~ImageTextAlternativeUI} plugins.
  *
  * @extends module:core/plugin~Plugin

+ 3 - 2
packages/ckeditor5-image/src/imagetextalternative/imagetextalternativeediting.js

@@ -11,8 +11,9 @@ import ImageTextAlternativeCommand from './imagetextalternativecommand';
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
 /**
- * The image text alternative engine plugin.
- * Registers the `imageTextAlternative` command.
+ * The image text alternative editing plugin.
+ *
+ * Registers the `'imageTextAlternative'` command.
  *
  * @extends module:core/plugin~Plugin
  */

+ 6 - 5
packages/ckeditor5-image/src/imagetoolbar.js

@@ -16,14 +16,15 @@ import { repositionContextualBalloon, getBalloonPositionData } from './image/ui/
 const balloonClassName = 'ck-toolbar-container';
 
 /**
- * The image toolbar class. Creates an image toolbar that shows up when the image widget is selected.
+ * The image toolbar plugin. It creates and manages the image toolbar (the toolbar displayed when an image is selected).
  *
- * Toolbar components are created using the editor {@link module:ui/componentfactory~ComponentFactory ComponentFactory}
- * based on the {@link module:core/editor/editor~Editor#config configuration} stored under `image.toolbar`.
+ * For a detailed overview, check the {@glink features/image#image-contextual-toolbar image contextual toolbar} documentation.
  *
- * The toolbar uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon}.
+ * Instanecs of toolbar components (e.g. buttons) are created using the editor's
+ * {@link module:ui/componentfactory~ComponentFactory component factory}
+ * based on the {@link module:image/image~ImageConfig#toolbar `image.toolbar` configuration option}.
  *
- * For a detailed overview, check the {@glink features/image#image-contextual-toolbar image contextual toolbar} documentation.
+ * The toolbar uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon}.
  *
  * @extends module:core/plugin~Plugin
  */

+ 3 - 2
packages/ckeditor5-image/src/imageupload.js

@@ -15,13 +15,14 @@ import ImageUploadEditing from './imageupload/imageuploadediting';
 /**
  * The image upload plugin.
  *
+ * For a detailed overview, check the {@glink features/image-upload image upload feature} documentation.
+ *
  * This plugin does not do anything directly, but it loads a set of specific plugins to enable image uploading:
+ *
  * * {@link module:image/imageupload/imageuploadediting~ImageUploadEditing},
  * * {@link module:image/imageupload/imageuploadui~ImageUploadUI},
  * * {@link module:image/imageupload/imageuploadprogress~ImageUploadProgress}.
  *
- * For a detailed overview, check the {@glink features/image-upload image upload feature} documentation.
- *
  * @extends module:core/plugin~Plugin
  */
 export default class ImageUpload extends Plugin {

+ 4 - 1
packages/ckeditor5-image/src/imageupload/imageuploadui.js

@@ -15,7 +15,10 @@ import { findOptimalInsertionPosition } from '@ckeditor/ckeditor5-widget/src/uti
 
 /**
  * The image upload button plugin.
- * Adds the `imageUpload` button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}.
+ *
+ * For a detailed overview, check the {@glink features/image-upload Image upload feature} documentation.
+ *
+ * Adds the `'imageUpload'` button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}.
  *
  * @extends module:core/plugin~Plugin
  */