瀏覽代碼

Docs: Fix links in documentation and update dropdown's properties.

Maciej Gołaszewski 7 年之前
父節點
當前提交
7d72e5e30f

+ 2 - 3
packages/ckeditor5-ui/src/button/splitbuttonview.js

@@ -53,8 +53,7 @@ export default class SplitButtonView extends View {
 		this.set( 'isEnabled', true );
 
 		/**
-		 * The label of the button view visible to the user when {@link #withText} is `true`.
-		 * It can also be used to create a {@link #tooltip}.
+		 * Used to create a {@link #tooltip}.
 		 *
 		 * @observable
 		 * @member {String} #label
@@ -72,7 +71,7 @@ export default class SplitButtonView extends View {
 
 		/**
 		 * (Optional) An XML {@link module:ui/icon/iconview~IconView#content content} of the icon.
-		 * When defined, an {@link #iconView} will be added to the action button.
+		 * When defined, an {@link module:ui/button/buttonview~ButtonView#iconView} will be added to the {@link #actionView} button.
 		 *
 		 * @observable
 		 * @member {String} #icon

+ 0 - 45
packages/ckeditor5-ui/src/dropdown/button/buttondropdownmodel.jsdoc

@@ -1,45 +0,0 @@
-/**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @module ui/dropdown/button/buttondropdownmodel
- */
-
-/**
- * The button dropdown model interface.
- *
- * @implements module:ui/dropdown/dropdownmodel~DropdownModel
- * @interface module:ui/dropdown/button/buttondropdownmodel~ButtonDropdownModel
- */
-
-/**
- * List of buttons to be included in dropdown
- *
- * @observable
- * @member {Array.<module:ui/button/buttonview~ButtonView>} #buttons
- */
-
-/**
- * Fired when the button dropdown is executed. It fires when one of the buttons
- * {@link module:ui/button/buttonview~ButtonView#event:execute executed}.
- *
- * @event #execute
- */
-
-/**
- * Controls dropdown direction.
- *
- * @observable
- * @member {Boolean} #isVertical=false
- */
-
-/**
- * Button dropdown icon is set from inner button views.
- *
- * Also see {@link #defaultIcon} and {@link #staticIcon}.
- *
- * @observable
- * @member {String} #icon
- */

+ 0 - 26
packages/ckeditor5-ui/src/dropdown/button/buttondropdownview.jsdoc

@@ -1,26 +0,0 @@
-/**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @module ui/dropdown/button/createbuttondropdown
- */
-
-/**
- * The button dropdown view.
- *
- * See {@link module:ui/dropdown/button/createbuttondropdown~createButtonDropdown}.
- *
- * @abstract
- * @class module:ui/dropdown/button/buttondropdownview~ButtonDropdownView
- * @extends module:ui/dropdown/dropdownview~DropdownView
- */
-
-/**
- * A child toolbar of the dropdown located in the
- * {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
- *
- * @readonly
- * @member {module:ui/toolbar/toolbarview~ToolbarView} #toolbarView
- */

+ 3 - 3
packages/ckeditor5-ui/src/dropdown/dropdownpanelview.js

@@ -36,9 +36,9 @@ export default class DropdownPanelView extends View {
 		/**
 		 * Collection of the child views in this panel.
 		 *
-		 * A common child type is the {@link module:list/list~List}. See
-		 * {@link module:ui/dropdown/list/createlistdropdown~createListDropdown} to learn more
-		 * about list dropdowns.
+		 * A common child type is the {@link module:ui/list/listview~ListView} and {@link module:ui/toolbar/toolbarview~ToolbarView}.
+		 * See {@link module:ui/dropdown/utils~addListToDropdown} and
+		 * {@link module:ui/dropdown/utils~addToolbarToDropdown} to learn more about child views of dropdowns.
 		 *
 		 * @readonly
 		 * @member {module:ui/viewcollection~ViewCollection}

+ 45 - 3
packages/ckeditor5-ui/src/dropdown/dropdownview.js

@@ -33,9 +33,8 @@ import '../../theme/components/dropdown/dropdown.css';
  *		// Will render a dropdown with a panel containing a "Content of the panel" text.
  *		document.body.appendChild( dropdown.element );
  *
- * Also see {@link module:ui/dropdown/createdropdown~createDropdown} and
- * {@link module:ui/dropdown/list/createlistdropdown~createListDropdown} to learn about different
- * dropdown creation helpers.
+ * Also see {@link module:ui/dropdown/utils~createDropdown} and {@link module:ui/dropdown/utils~createSplitButtonDropdown}
+ * to learn about different dropdown creation helpers.
  *
  * @extends module:ui/view~View
  */
@@ -210,6 +209,49 @@ export default class DropdownView extends View {
 		 * @observable
 		 * @member {Boolean} #icon
 		 */
+
+		/**
+		 * Controls dropdown's toolbar direction.
+		 * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addToolbarToDropdown}.
+		 *
+		 * @observable
+		 * @member {Boolean} #isVertical=false
+		 */
+
+		/**
+		 * A child {@link module:ui/list/listview~ListView list view} of the dropdown located
+		 * in its {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
+		 *
+		 * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addListToDropdown}.
+		 *
+		 * @readonly
+		 * @member {module:ui/list/listview~ListView} #listView
+		 */
+
+		/**
+		 * A child toolbar of the dropdown located in the
+		 * {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
+		 *
+		 * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addToolbarToDropdown}.
+		 *
+		 * @readonly
+		 * @member {module:ui/toolbar/toolbarview~ToolbarView} #toolbarView
+		 */
+
+		/**
+		 * Fired when the toolbar button or list item is executed.
+		 *
+		 * For {@link #listView} It fires when one of the list items has been
+		 * {@link module:ui/list/listitemview~ListItemView#event:execute executed}.
+		 *
+		 * For {@link #toolbarView} It fires when one of the buttons has been
+		 * {@link module:ui/button/buttonview~ButtonView#event:execute executed}.
+		 *
+		 * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addListToDropdown}
+		 * or {@link module:ui/dropdown/utils~addToolbarToDropdown}.
+		 *
+		 * @event #execute
+		 */
 	}
 
 	/**

+ 0 - 33
packages/ckeditor5-ui/src/dropdown/list/listdropdownmodel.jsdoc

@@ -1,33 +0,0 @@
-/**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @module ui/dropdown/list/listdropdownmodel
- */
-
-/**
- * The list dropdown model interface.
- *
- * @implements module:ui/dropdown/dropdownmodel~DropdownModel
- * @interface module:ui/dropdown/list/listdropdownmodel~ListDropdownModel
- */
-
-/**
- * A {@link module:utils/collection~Collection} of {@link module:utils/observablemixin~Observable}
- * that the inner dropdown {@link module:ui/list/listview~ListView} children are created from.
- *
- * Usually, it is a collection of {@link module:ui/model~Model models}.
- *
- * @observable
- * @member {module:utils/collection~Collection.<module:utils/observablemixin~Observable>} #items
- */
-
-/**
- * Fired when the list dropdown is executed. It fires when one of the list items in
- * {@link #items the collection} has been
- * {@link module:ui/list/listitemview~ListItemView#event:execute executed}.
- *
- * @event #execute
- */

+ 0 - 41
packages/ckeditor5-ui/src/dropdown/list/listdropdownview.jsdoc

@@ -1,41 +0,0 @@
-/**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @module ui/dropdown/list/createlistdropdown
- */
-
-/**
- * The list dropdown view.
- *
- * See {@link module:ui/dropdown/list/createlistdropdown~createListDropdown}.
- *
- * @abstract
- * @class module:ui/dropdown/list/listdropdownview~ListDropdownView
- * @extends module:ui/dropdown/dropdownview~DropdownView
- */
-
-/**
- * A child {@link module:ui/list/listview~ListView list view} of the dropdown located
- * in its {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
- *
- * @readonly
- * @member {module:ui/list/listview~ListView} #listView
- */
-
-/**
- *
- *
- * @observable
- * @member {module:utils/collection~Collection.<module:utils/observablemixin~Observable>} #items
- */
-
-/**
- * Fired when the list dropdown is executed. It fires when one of the list items in
- * {@link #items the collection} has been
- * {@link module:ui/list/listitemview~ListItemView#event:execute executed}.
- *
- * @event #execute
- */

+ 2 - 2
packages/ckeditor5-ui/src/dropdown/utils.js

@@ -135,7 +135,7 @@ export function addToolbarToDropdown( dropdownView, buttons ) {
 }
 
 /**
- * Adds an instance of {@link module:ui/dropdown/list/listdropdownview~ListDropdownView} to a dropdown.
+ * Adds an instance of {@link module:ui/list/listview~ListView} to a dropdown.
  *
  *		const items = new Collection();
  *
@@ -158,7 +158,7 @@ export function addToolbarToDropdown( dropdownView, buttons ) {
  * and {@link module:list/list~List}.
  *
  * @param {module:ui/dropdown/dropdownview~DropdownView} dropdownView A dropdown instance to which `ListVIew` will be added.
- * @param {module:utils/collection~Collection.<module:utils/observablemixin~Observable>} items
+ * @param {module:utils/collection~Collection} items
  * that the inner dropdown {@link module:ui/list/listview~ListView} children are created from.
  *
  * Usually, it is a collection of {@link module:ui/model~Model models}.