Explorar o código

Fix the plugin file structure and API documentation.

panr %!s(int64=5) %!d(string=hai) anos
pai
achega
686c333a50

+ 4 - 3
packages/ckeditor5-image/src/imageresize.js

@@ -8,7 +8,7 @@
  */
  */
 
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
-import ImageResizeUI from './imageresize/ui/imageresizeui';
+import ImageResizeUI from './imageresize/imageresizeui';
 import ImageResizeEditing from './imageresize/imageresizeediting';
 import ImageResizeEditing from './imageresize/imageresizeediting';
 
 
 import '../theme/imageresize.css';
 import '../theme/imageresize.css';
@@ -61,7 +61,7 @@ export default class ImageResize extends Plugin {
  * The resize options.
  * The resize options.
  *
  *
  * Each option should have its `name`, which is a component name definition that will be
  * Each option should have its `name`, which is a component name definition that will be
- * used in the {@link module:image/imageresize/ui/imageresizeui~ImageResizeUI} plugin.
+ * used in the {@link module:image/imageresize/imageresizeui~ImageResizeUI} plugin.
  * Other properties like `label` and `value` define the following:
  * Other properties like `label` and `value` define the following:
  * a text label for the option button and the value that will be applied to the image's width.
  * a text label for the option button and the value that will be applied to the image's width.
  *
  *
@@ -151,5 +151,6 @@ export default class ImageResize extends Plugin {
  *			.then( ... )
  *			.then( ... )
  *			.catch( ... );
  *			.catch( ... );
  *
  *
- * @member {String} module:image/image~ImageConfig#resizeOptions
+ *
+ * @member {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} module:image/image~ImageConfig#resizeOptions
  */
  */

+ 1 - 1
packages/ckeditor5-image/src/imageresize/imageresizeediting.js

@@ -15,7 +15,7 @@ import ImageResizeCommand from './imageresizecommand';
  * The image resize feature.
  * The image resize feature.
  *
  *
  * It adds a possibility to resize each image using handles or manually by
  * It adds a possibility to resize each image using handles or manually by
- * {@link module:image/imageresize/ui/imageresizeui~ImageResizeUI} buttons.
+ * {@link module:image/imageresize/imageresizeui~ImageResizeUI} buttons.
  *
  *
  * @extends module:core/plugin~Plugin
  * @extends module:core/plugin~Plugin
  */
  */

+ 9 - 6
packages/ckeditor5-image/src/imageresize/ui/imageresizeui.js → packages/ckeditor5-image/src/imageresize/imageresizeui.js

@@ -4,12 +4,12 @@
  */
  */
 
 
 /**
 /**
- * @module image/imageresize/ui/imageresizeui
+ * @module image/imageresize/imageresizeui
  */
  */
 
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
-import ImageResizeEditing from '../imageresizeediting';
+import ImageResizeEditing from './imageresizeediting';
 import { createDropdown, addListToDropdown } from '@ckeditor/ckeditor5-ui/src/dropdown/utils';
 import { createDropdown, addListToDropdown } from '@ckeditor/ckeditor5-ui/src/dropdown/utils';
 import DropdownButtonView from '@ckeditor/ckeditor5-ui/src/dropdown/button/dropdownbuttonview';
 import DropdownButtonView from '@ckeditor/ckeditor5-ui/src/dropdown/button/dropdownbuttonview';
 
 
@@ -65,7 +65,8 @@ export default class ImageResizeUI extends Plugin {
 	 *
 	 *
 	 * @private
 	 * @private
 	 *
 	 *
-	 * @param {module:image/imageresizeui~resizeOption} resizeOption A model of resize option.
+	 * @param {module:image/imageresize/imageresizeui~ImageResizeOption} resizeOption A model of resize option.
+	 * @param {String} unit A resize unit.
 	 */
 	 */
 	_addButton( { name, label, value }, unit ) {
 	_addButton( { name, label, value }, unit ) {
 		const editor = this.editor;
 		const editor = this.editor;
@@ -103,7 +104,8 @@ export default class ImageResizeUI extends Plugin {
 	 *
 	 *
 	 * @private
 	 * @private
 	 *
 	 *
-	 * @param {Array.<module:image/imageresizeui~resizeOption>} options An array of the configured options.
+	 * @param {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} options An array of the configured options.
+	 * @param {String} unit A resize unit.
 	 */
 	 */
 	_addDropdown( options, unit ) {
 	_addDropdown( options, unit ) {
 		const editor = this.editor;
 		const editor = this.editor;
@@ -188,9 +190,10 @@ function setOptionOn( value ) {
 /**
 /**
  * A resize option type.
  * A resize option type.
  *
  *
- * @typedef {Object} module:image/imageresizeui~resizeOption
+ * @typedef {Object} module:image/imageresize/imageresizeui~ImageResizeOption
  *
  *
  * @property {String} resizeOption.name A name of the option used for creating a component.
  * @property {String} resizeOption.name A name of the option used for creating a component.
+ * You refer to that name later in the {@link module:image/image~ImageConfig#toolbar}.
  * @property {String} resizeOption.label A label to be displayed with a button.
  * @property {String} resizeOption.label A label to be displayed with a button.
- * @property {String} resizeOption.value A value of a resize option.
+ * @property {String} resizeOption.value A value of a resize option. `null` value is for resetting an image to its original size.
  */
  */

+ 1 - 1
packages/ckeditor5-image/tests/imageresize/imageresize.js

@@ -4,7 +4,7 @@
  */
  */
 
 
 import ImageResize from '../../src/imageresize';
 import ImageResize from '../../src/imageresize';
-import ImageResizeUI from '../../src/imageresize/ui/imageresizeui';
+import ImageResizeUI from '../../src/imageresize/imageresizeui';
 import ImageResizeEditing from '../../src/imageresize/imageresizeediting';
 import ImageResizeEditing from '../../src/imageresize/imageresizeediting';
 
 
 describe( 'ImageResize', () => {
 describe( 'ImageResize', () => {

+ 3 - 3
packages/ckeditor5-image/tests/imageresize/ui/imageresizeui.js → packages/ckeditor5-image/tests/imageresize/imageresizeui.js

@@ -7,12 +7,12 @@
 
 
 import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
 import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
 import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
 import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
-import Image from '../../../src/image';
+import Image from '../../src/image';
 import DropdownView from '@ckeditor/ckeditor5-ui/src/dropdown/dropdownview';
 import DropdownView from '@ckeditor/ckeditor5-ui/src/dropdown/dropdownview';
 import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import View from '@ckeditor/ckeditor5-ui/src/view';
 import View from '@ckeditor/ckeditor5-ui/src/view';
-import ImageResizeUI from '../../../src/imageresize/ui/imageresizeui';
-import ImageStyle from '../../../src/imagestyle';
+import ImageResizeUI from '../../src/imageresize/imageresizeui';
+import ImageStyle from '../../src/imagestyle';
 import Undo from '@ckeditor/ckeditor5-undo/src/undo';
 import Undo from '@ckeditor/ckeditor5-undo/src/undo';
 import Table from '@ckeditor/ckeditor5-table/src/table';
 import Table from '@ckeditor/ckeditor5-table/src/table';