From 231b21c0d50077a4b24771f520f4d40c3983b59d Mon Sep 17 00:00:00 2001 From: Justin Fagnani Date: Wed, 26 Apr 2017 14:51:09 -0700 Subject: [PATCH 1/3] @polymerElement -> @customElement/@polymer --- lib/elements/array-selector.html | 3 ++- lib/elements/dom-if.html | 3 ++- lib/elements/dom-repeat.html | 3 ++- polymer-element.html | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/elements/array-selector.html b/lib/elements/array-selector.html index 85603aaed6..7dec336293 100644 --- a/lib/elements/array-selector.html +++ b/lib/elements/array-selector.html @@ -390,7 +390,8 @@ * }); * ``` * - * @polymerElement + * @customElement + * @polymer * @extends Polymer.Element * @mixes Polymer.ArraySelectorMixin * @memberof Polymer diff --git a/lib/elements/dom-if.html b/lib/elements/dom-if.html index 842e5a6593..1353dbdefd 100644 --- a/lib/elements/dom-if.html +++ b/lib/elements/dom-if.html @@ -33,7 +33,8 @@ * Set the `restamp` property to true to force the stamped content to be * created / destroyed when the `if` condition changes. * - * @polymerElement + * @customElement + * @polymer * @extends Polymer.Element * @memberof Polymer * @summary Custom element that conditionally stamps and hides or removes diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html index 5efa30a43d..113b7082f2 100644 --- a/lib/elements/dom-repeat.html +++ b/lib/elements/dom-repeat.html @@ -112,7 +112,8 @@ * filter="isEngineer" observe="type manager.type"> * ``` * - * @polymerElement + * @customElement + * @polymer * @memberof Polymer * @extends Polymer.Element * @mixes Polymer.MutableData diff --git a/polymer-element.html b/polymer-element.html index 1dac595c13..d576fbd81e 100644 --- a/polymer-element.html +++ b/polymer-element.html @@ -17,7 +17,8 @@ * features including template stamping, data-binding, attribute deserialization, * and property change observation. * - * @polymerElement + * @customElement + * @polymer * @memberof Polymer * @constructor * @implements {Polymer_ElementMixin} From f7e8021e78af24421d95d44c65597bfb4ac9fbfe Mon Sep 17 00:00:00 2001 From: Justin Fagnani Date: Wed, 26 Apr 2017 14:58:43 -0700 Subject: [PATCH 2/3] @polymerMixin/@polymerMixinClass -> @mixinFunction/@mixinClass --- lib/elements/array-selector.html | 5 +++-- lib/legacy/legacy-element-mixin.html | 5 +++-- lib/mixins/element-mixin.html | 5 +++-- lib/mixins/gesture-event-listeners.html | 5 +++-- lib/mixins/mutable-data.html | 10 ++++++---- lib/mixins/property-accessors.html | 5 +++-- lib/mixins/property-effects.html | 5 +++-- lib/mixins/template-stamp.html | 5 +++-- 8 files changed, 27 insertions(+), 18 deletions(-) diff --git a/lib/elements/array-selector.html b/lib/elements/array-selector.html index 7dec336293..1533f2ed40 100644 --- a/lib/elements/array-selector.html +++ b/lib/elements/array-selector.html @@ -30,13 +30,14 @@ * representing the last selected item. When `multi` is true, `selected` * is an array of multiply selected items. * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer */ let ArraySelectorMixin = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_ArraySelectorMixin} */ class ArraySelectorMixin extends superClass { diff --git a/lib/legacy/legacy-element-mixin.html b/lib/legacy/legacy-element-mixin.html index 013d86efd8..a8a1dc4ae1 100644 --- a/lib/legacy/legacy-element-mixin.html +++ b/lib/legacy/legacy-element-mixin.html @@ -30,7 +30,8 @@ * found on the Polymer 1.x `Polymer.Base` prototype applied to all elements * defined using the `Polymer({...})` function. * - * @polymerMixin + * @mixinFunction + * @polymer * @mixes Polymer.ElementMixin * @mixes Polymer.GestureEventListeners * @property isAttached {boolean} Set to `true` in this element's @@ -60,7 +61,7 @@ }; /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_LegacyElement} */ class LegacyElement extends legacyElementBase { diff --git a/lib/mixins/element-mixin.html b/lib/mixins/element-mixin.html index a3bb9c9eec..9f09a6f782 100644 --- a/lib/mixins/element-mixin.html +++ b/lib/mixins/element-mixin.html @@ -101,7 +101,8 @@ * `observedAttributes` implementation will automatically return an array * of dash-cased attributes based on `properties`) * - * @polymerMixin + * @mixinFunction + * @polymer * @mixes Polymer.PropertyEffects * @memberof Polymer * @property rootPath {string} Set to the value of `Polymer.rootPath`, @@ -452,7 +453,7 @@ } /** - * @polymerMixinClass + * @mixinClass * @unrestricted * @implements {Polymer_ElementMixin} */ diff --git a/lib/mixins/gesture-event-listeners.html b/lib/mixins/gesture-event-listeners.html index dcf163daef..9d00a1bead 100644 --- a/lib/mixins/gesture-event-listeners.html +++ b/lib/mixins/gesture-event-listeners.html @@ -26,7 +26,8 @@ * templates will support gesture events when this mixin is applied along with * `Polymer.TemplateStamp`. * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer * @summary Element class mixin that provides API for adding Polymer's cross-platform * gesture events to nodes @@ -34,7 +35,7 @@ Polymer.GestureEventListeners = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_GestureEventListeners} */ class GestureEventListeners extends superClass { diff --git a/lib/mixins/mutable-data.html b/lib/mixins/mutable-data.html index 9cb64930fe..8159685cf7 100644 --- a/lib/mixins/mutable-data.html +++ b/lib/mixins/mutable-data.html @@ -65,7 +65,8 @@ * will be worse as opposed to using strict dirty checking with immutable * patterns or Polymer's path notification API. * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer * @summary Element class mixin to skip strict dirty-checking for objects * and arrays @@ -73,7 +74,7 @@ Polymer.MutableData = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_MutableData} */ class MutableData extends superClass { @@ -136,7 +137,8 @@ * strict dirty checking with immutable patterns or Polymer's path notification * API. * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer * @summary Element class mixin to optionally skip strict dirty-checking * for objects and arrays @@ -144,7 +146,7 @@ Polymer.OptionalMutableData = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_OptionalMutableData} */ class OptionalMutableData extends superClass { diff --git a/lib/mixins/property-accessors.html b/lib/mixins/property-accessors.html index a586f31a2d..31e1a53838 100644 --- a/lib/mixins/property-accessors.html +++ b/lib/mixins/property-accessors.html @@ -86,7 +86,8 @@ * deserialized via `attributeChangedCallback` and set to the associated * property using `dash-case`-to-`camelCase` convention. * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer * @summary Element class mixin for reacting to property changes from * generated property accessors. @@ -94,7 +95,7 @@ Polymer.PropertyAccessors = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_PropertyAccessors} * @unrestricted */ diff --git a/lib/mixins/property-effects.html b/lib/mixins/property-effects.html index 2321826b7e..1b76b64277 100644 --- a/lib/mixins/property-effects.html +++ b/lib/mixins/property-effects.html @@ -1045,7 +1045,8 @@ * whereas the default when using `PropertyAccessors` standalone is to be * async by default. * - * @polymerMixin + * @mixinFunction + * @polymer * @mixes Polymer.TemplateStamp * @mixes Polymer.PropertyAccessors * @memberof Polymer @@ -1063,7 +1064,7 @@ const propertyEffectsBase = Polymer.TemplateStamp(Polymer.PropertyAccessors(superClass)); /** - * @polymerMixinClass + * @mixinClass * @unrestricted * @implements {Polymer_PropertyEffects} */ diff --git a/lib/mixins/template-stamp.html b/lib/mixins/template-stamp.html index fee06c90a2..2b7ff29840 100644 --- a/lib/mixins/template-stamp.html +++ b/lib/mixins/template-stamp.html @@ -106,14 +106,15 @@ * - Nested template content caching/removal and re-installation (performance * optimization) * - * @polymerMixin + * @mixinFunction + * @polymer * @memberof Polymer * @summary Element class mixin that provides basic template parsing and stamping */ Polymer.TemplateStamp = Polymer.dedupingMixin(superClass => { /** - * @polymerMixinClass + * @mixinClass * @implements {Polymer_TemplateStamp} */ class TemplateStamp extends superClass { From 1f21ab1acdbae9aa2879d87bd4d6b80dc4648102 Mon Sep 17 00:00:00 2001 From: Justin Fagnani Date: Wed, 26 Apr 2017 15:05:33 -0700 Subject: [PATCH 3/3] @mixes -> @appliesMixin --- lib/elements/array-selector.html | 2 +- lib/elements/dom-bind.html | 2 +- lib/elements/dom-repeat.html | 2 +- lib/legacy/legacy-element-mixin.html | 4 ++-- lib/mixins/element-mixin.html | 2 +- lib/mixins/property-effects.html | 4 ++-- polymer-element.html | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/elements/array-selector.html b/lib/elements/array-selector.html index 1533f2ed40..c23af7c9cb 100644 --- a/lib/elements/array-selector.html +++ b/lib/elements/array-selector.html @@ -394,7 +394,7 @@ * @customElement * @polymer * @extends Polymer.Element - * @mixes Polymer.ArraySelectorMixin + * @appliesMixin Polymer.ArraySelectorMixin * @memberof Polymer * @summary Custom element that links paths between an input `items` array and * an output `selected` item or array based on calls to its selection API. diff --git a/lib/elements/dom-bind.html b/lib/elements/dom-bind.html index 436791d85c..bf6cc804b7 100644 --- a/lib/elements/dom-bind.html +++ b/lib/elements/dom-bind.html @@ -41,7 +41,7 @@ * binding scope. * * @extends HTMLElement - * @mixes Polymer.PropertyEffects + * @appliesMixin Polymer.PropertyEffects * @memberof Polymer * @summary Custom element to allow using Polymer's template features (data * binding, declarative event listeners, etc.) in the main document. diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html index 113b7082f2..27a3d21f2a 100644 --- a/lib/elements/dom-repeat.html +++ b/lib/elements/dom-repeat.html @@ -116,7 +116,7 @@ * @polymer * @memberof Polymer * @extends Polymer.Element - * @mixes Polymer.MutableData + * @appliesMixin Polymer.MutableData * @summary Custom element for stamping instance of a template bound to * items in an array. */ diff --git a/lib/legacy/legacy-element-mixin.html b/lib/legacy/legacy-element-mixin.html index a8a1dc4ae1..18497c6763 100644 --- a/lib/legacy/legacy-element-mixin.html +++ b/lib/legacy/legacy-element-mixin.html @@ -32,8 +32,8 @@ * * @mixinFunction * @polymer - * @mixes Polymer.ElementMixin - * @mixes Polymer.GestureEventListeners + * @appliesMixin Polymer.ElementMixin + * @appliesMixin Polymer.GestureEventListeners * @property isAttached {boolean} Set to `true` in this element's * `connectedCallback` and `false` in `disconnectedCallback` * @memberof Polymer diff --git a/lib/mixins/element-mixin.html b/lib/mixins/element-mixin.html index 9f09a6f782..2e79ba6ef7 100644 --- a/lib/mixins/element-mixin.html +++ b/lib/mixins/element-mixin.html @@ -103,7 +103,7 @@ * * @mixinFunction * @polymer - * @mixes Polymer.PropertyEffects + * @appliesMixin Polymer.PropertyEffects * @memberof Polymer * @property rootPath {string} Set to the value of `Polymer.rootPath`, * which defaults to the main document path diff --git a/lib/mixins/property-effects.html b/lib/mixins/property-effects.html index 1b76b64277..75d2bc55f3 100644 --- a/lib/mixins/property-effects.html +++ b/lib/mixins/property-effects.html @@ -1047,8 +1047,8 @@ * * @mixinFunction * @polymer - * @mixes Polymer.TemplateStamp - * @mixes Polymer.PropertyAccessors + * @appliesMixin Polymer.TemplateStamp + * @appliesMixin Polymer.PropertyAccessors * @memberof Polymer * @summary Element class mixin that provides meta-programming for Polymer's * template binding and data observation system. diff --git a/polymer-element.html b/polymer-element.html index d576fbd81e..cf984965fd 100644 --- a/polymer-element.html +++ b/polymer-element.html @@ -23,7 +23,7 @@ * @constructor * @implements {Polymer_ElementMixin} * @extends HTMLElement - * @mixes Polymer.ElementMixin + * @appliesMixin Polymer.ElementMixin * @summary Custom element base class that provides the core API for Polymer's * key meta-programming features including template stamping, data-binding, * attribute deserialization, and property change observation