Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Docs: Improved links between API and guides. See ckeditor/ckeditor5#1090
Browse files Browse the repository at this point in the history
.
  • Loading branch information
Reinmar committed Sep 18, 2018
1 parent 26638f5 commit 7ce0181
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/api/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
10 changes: 8 additions & 2 deletions src/image.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
6 changes: 3 additions & 3 deletions src/imagestyle.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 4 additions & 1 deletion src/imagetextalternative.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions src/imagetextalternative/imagetextalternativeediting.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
11 changes: 6 additions & 5 deletions src/imagetoolbar.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
5 changes: 3 additions & 2 deletions src/imageupload.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 4 additions & 1 deletion src/imageupload/imageuploadui.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down

0 comments on commit 7ce0181

Please sign in to comment.