refactor: update documentation

vaadin · Jan 22, 2023 · 80e5343 · 80e5343
1 parent b15a94a
commit 80e5343
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 9 deletions.
diff --git a/packages/context-menu/src/vaadin-contextmenu-items-mixin.js b/packages/context-menu/src/vaadin-contextmenu-items-mixin.js
@@ -42,7 +42,6 @@ export const ItemsMixin = (superClass) =>
   class ItemsMixin extends superClass {
     static get properties() {
       return {
-        // TODO update docs
         /**
          * @typedef ContextMenuItem
          * @type {object}
@@ -89,7 +88,7 @@ export const ItemsMixin = (superClass) =>
          * ### Styling
          *
          * The `<vaadin-context-menu-item>` sub-menu elements have the following additional state attributes on top of
-         * the built-in `<vaadin-menu-item-base>` state attributes (see `<vaadin-menu-item-base>` documentation for full listing).
+         * the built-in `<vaadin-item>` state attributes (see `<vaadin-item>` documentation for full listing).
          *
          * Part name | Attribute | Description
          * ----------------|----------------|----------------

diff --git a/packages/context-menu/src/vaadin-menu-item-base.d.ts b/packages/context-menu/src/vaadin-menu-item-base.d.ts
@@ -4,11 +4,10 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 
-// TODO add docs
 import { Item } from '@vaadin/item/src/vaadin-item';
 
 /**
- *
+ * A base item class used by menus. Not intended to be used separately.
  */
 declare class MenuItemBase extends Item {}
 

diff --git a/packages/context-menu/src/vaadin-menu-item-base.js b/packages/context-menu/src/vaadin-menu-item-base.js
@@ -4,12 +4,10 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 
-// TODO update docs
-
 import { Item } from '@vaadin/item/src/vaadin-item';
 
 /**
- * A base element used for menu items.
+ * A base item class used by menus. Not intended to be used separately.
  * @extends Item
  * @private
  */

diff --git a/packages/menu-bar/src/vaadin-menu-bar.d.ts b/packages/menu-bar/src/vaadin-menu-bar.d.ts
@@ -101,7 +101,7 @@ export interface MenuBarEventMap extends HTMLElementEventMap, MenuBarCustomEvent
  * components are themable:
  *
  * - `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).
- * - `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-menu-item-base>`](#/elements/vaadin-menu-item-base).
+ * - `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
  * - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
  * - `<vaadin-context-menu-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
  *

diff --git a/packages/menu-bar/src/vaadin-menu-bar.js b/packages/menu-bar/src/vaadin-menu-bar.js
@@ -52,7 +52,7 @@ import { MenuBarMixin } from './vaadin-menu-bar-mixin.js';
  * components are themable:
  *
  * - `<vaadin-menu-bar-button>` - has the same API as [`<vaadin-button>`](#/elements/vaadin-button).
- * - `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-menu-item-base>`](#/elements/vaadin-menu-item-base).
+ * - `<vaadin-menu-bar-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
  * - `<vaadin-context-menu-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
  * - `<vaadin-context-menu-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
  *