Browse Source

Docs: Extended documentation of the ImageStyleEngine.localizedDefaultStylesTitles.

Aleksander Nowodzinski 8 years ago
parent
commit
efc7bc0fff
1 changed files with 9 additions and 0 deletions
  1. 9 0
      packages/ckeditor5-image/src/imagestyle/imagestyleengine.js

+ 9 - 0
packages/ckeditor5-image/src/imagestyle/imagestyleengine.js

@@ -108,6 +108,15 @@ export default class ImageStyleEngine extends Plugin {
 	 * Returns the default localized style titles provided by the plugin e.g. ready to
 	 * use in the {@link #imageStyles}.
 	 *
+	 * The following localized titles corresponding with
+	 * {@link module:image/imagestyle/imagestyleengine~ImageStyleEngine.defaultStyles} are available:
+	 *
+	 * * `'Full size image'`,
+	 * * `'Side image'`,
+	 * * `'Left aligned image'`,
+	 * * `'Centered image'`,
+	 * * `'Right aligned image'`
+	 *
 	 * @readonly
 	 * @type {Object.<String,String>}
 	 */