Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jsdoc new tags #4568

Merged
merged 3 commits into from
Jun 20, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions lib/elements/array-selector.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -390,9 +391,10 @@
* });
* ```
*
* @polymerElement
* @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.
Expand Down
2 changes: 1 addition & 1 deletion lib/elements/dom-bind.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion lib/elements/dom-if.html
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions lib/elements/dom-repeat.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,11 @@
* filter="isEngineer" observe="type manager.type">
* ```
*
* @polymerElement
* @customElement
* @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.
*/
Expand Down
9 changes: 5 additions & 4 deletions lib/legacy/legacy-element-mixin.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
* found on the Polymer 1.x `Polymer.Base` prototype applied to all elements
* defined using the `Polymer({...})` function.
*
* @polymerMixin
* @mixes Polymer.ElementMixin
* @mixes Polymer.GestureEventListeners
* @mixinFunction
* @polymer
* @appliesMixin Polymer.ElementMixin
* @appliesMixin Polymer.GestureEventListeners
* @property isAttached {boolean} Set to `true` in this element's
* `connectedCallback` and `false` in `disconnectedCallback`
* @memberof Polymer
Expand Down Expand Up @@ -60,7 +61,7 @@
};

/**
* @polymerMixinClass
* @mixinClass
* @implements {Polymer_LegacyElement}
*/
class LegacyElement extends legacyElementBase {
Expand Down
7 changes: 4 additions & 3 deletions lib/mixins/element-mixin.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,9 @@
* `observedAttributes` implementation will automatically return an array
* of dash-cased attributes based on `properties`)
*
* @polymerMixin
* @mixes Polymer.PropertyEffects
* @mixinFunction
* @polymer
* @appliesMixin Polymer.PropertyEffects
* @memberof Polymer
* @property rootPath {string} Set to the value of `Polymer.rootPath`,
* which defaults to the main document path
Expand Down Expand Up @@ -452,7 +453,7 @@
}

/**
* @polymerMixinClass
* @mixinClass
* @unrestricted
* @implements {Polymer_ElementMixin}
*/
Expand Down
5 changes: 3 additions & 2 deletions lib/mixins/gesture-event-listeners.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,16 @@
* 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
*/
Polymer.GestureEventListeners = Polymer.dedupingMixin(superClass => {

/**
* @polymerMixinClass
* @mixinClass
* @implements {Polymer_GestureEventListeners}
*/
class GestureEventListeners extends superClass {
Expand Down
10 changes: 6 additions & 4 deletions lib/mixins/mutable-data.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,16 @@
* 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
*/
Polymer.MutableData = Polymer.dedupingMixin(superClass => {

/**
* @polymerMixinClass
* @mixinClass
* @implements {Polymer_MutableData}
*/
class MutableData extends superClass {
Expand Down Expand Up @@ -136,15 +137,16 @@
* 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
*/
Polymer.OptionalMutableData = Polymer.dedupingMixin(superClass => {

/**
* @polymerMixinClass
* @mixinClass
* @implements {Polymer_OptionalMutableData}
*/
class OptionalMutableData extends superClass {
Expand Down
5 changes: 3 additions & 2 deletions lib/mixins/property-accessors.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,16 @@
* 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.
*/
Polymer.PropertyAccessors = Polymer.dedupingMixin(superClass => {

/**
* @polymerMixinClass
* @mixinClass
* @implements {Polymer_PropertyAccessors}
* @unrestricted
*/
Expand Down
9 changes: 5 additions & 4 deletions lib/mixins/property-effects.html
Original file line number Diff line number Diff line change
Expand Up @@ -1045,9 +1045,10 @@
* whereas the default when using `PropertyAccessors` standalone is to be
* async by default.
*
* @polymerMixin
* @mixes Polymer.TemplateStamp
* @mixes Polymer.PropertyAccessors
* @mixinFunction
* @polymer
* @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.
Expand All @@ -1063,7 +1064,7 @@
const propertyEffectsBase = Polymer.TemplateStamp(Polymer.PropertyAccessors(superClass));

/**
* @polymerMixinClass
* @mixinClass
* @unrestricted
* @implements {Polymer_PropertyEffects}
*/
Expand Down
5 changes: 3 additions & 2 deletions lib/mixins/template-stamp.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 3 additions & 2 deletions polymer-element.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,13 @@
* features including template stamping, data-binding, attribute deserialization,
* and property change observation.
*
* @polymerElement
* @customElement
* @polymer
* @memberof Polymer
* @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
Expand Down