mirror of
https://github.com/Polymer/polymer.git
synced 2025-02-25 18:55:30 -06:00
Add mixin @summary's and more API docs.
This commit is contained in:
parent
f4691e2c7f
commit
722790b60c
@ -41,7 +41,11 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
CustomStyleInterface.addCustomStyle(this);
|
||||
}
|
||||
/**
|
||||
* TODOC
|
||||
* Returns the light-DOM `<style>` child this element wraps. Upon first
|
||||
* call any style modules referenced via the `include` attribute will be
|
||||
* concatenated to this element's `<style>`.
|
||||
*
|
||||
* @return {HTMLStyleElement} This element's light-DOM `<style>`
|
||||
*/
|
||||
getStyle() {
|
||||
if (this._style) {
|
||||
|
@ -30,12 +30,11 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
* found on the Polymer 1.x `Polymer.Base` prototype applied to all elements
|
||||
* defined using the `Polymer({...})` function.
|
||||
*
|
||||
* TODOC
|
||||
*
|
||||
* @polymerMixin
|
||||
* @mixes Polymer.ElementMixin
|
||||
* @mixes Polymer.GestureEventListeners
|
||||
* @memberof Polymer
|
||||
* @summary Element class mixin that provides Polymer's "legacy" API
|
||||
*/
|
||||
Polymer.LegacyElementMixin = Polymer.dedupingMixin(function(base) {
|
||||
|
||||
|
@ -52,6 +52,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
* @polymerMixin
|
||||
* @mixes Polymer.PropertyEffects
|
||||
* @memberof Polymer
|
||||
* @summary Element class mixin that provides the core API for Polymer's
|
||||
* meta-programming features.
|
||||
*/
|
||||
Polymer.ElementMixin = Polymer.dedupingMixin(function(base) {
|
||||
|
||||
|
@ -28,6 +28,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
*
|
||||
* @polymerMixin
|
||||
* @memberof Polymer
|
||||
* @summary Element class mixin that provides API for adding Polymer's cross-platform
|
||||
* gesture events to nodes
|
||||
*/
|
||||
Polymer.GestureEventListeners = Polymer.dedupingMixin(function(superClass) {
|
||||
|
||||
|
@ -85,6 +85,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
*
|
||||
* @polymerMixin
|
||||
* @memberof Polymer
|
||||
* @summary Element class mixin for reacting to property changes from
|
||||
* generated property accessors.
|
||||
*/
|
||||
Polymer.PropertyAccessors = Polymer.dedupingMixin(function(superClass) {
|
||||
|
||||
|
@ -1229,6 +1229,8 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
* @mixes Polymer.TemplateStamp
|
||||
* @mixes Polymer.PropertyAccessors
|
||||
* @memberof Polymer
|
||||
* @summary Element class mixin that provides meta-programming for Polymer's
|
||||
* template binding and data observation system.
|
||||
*/
|
||||
Polymer.PropertyEffects = Polymer.dedupingMixin(function(superClass) {
|
||||
|
||||
|
@ -449,6 +449,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
*
|
||||
* @polymerMixin
|
||||
* @memberof Polymer
|
||||
* @summary Element mixin that provides basic template parsing and stamping
|
||||
*/
|
||||
Polymer.TemplateStamp = Polymer.dedupingMixin(function(superClass) {
|
||||
|
||||
|
@ -14,9 +14,10 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
let debouncerQueue = [];
|
||||
|
||||
/**
|
||||
* TODOC
|
||||
* Adds a `Polymer.Debouncer` to a list of globally flushable tasks.
|
||||
*
|
||||
* @memberof Polymer
|
||||
* @param {Polymer.Debouncer} debouncer Debouncer to enqueue
|
||||
*/
|
||||
Polymer.enqueueDebouncer = function(debouncer) {
|
||||
debouncerQueue.push(debouncer);
|
||||
@ -37,7 +38,9 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
}
|
||||
|
||||
/**
|
||||
* TODOC
|
||||
* Forces several classes of asynchronously queued tasks to flush:
|
||||
* - Debouncers added via `enqueueDebouncer`
|
||||
* - ShadyDOM distribution
|
||||
*
|
||||
* @memberof Polymer
|
||||
*/
|
||||
|
@ -59,12 +59,14 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
|
||||
};
|
||||
|
||||
/**
|
||||
* Given a mixin producing function, only apply mixin if has not already been
|
||||
* applied to base. Also memoizes mixin applications.
|
||||
*
|
||||
* TODOC
|
||||
* Wraps an ES6 class expression mixin such that the mixin is only applied
|
||||
* if it has not already been applied its base argument. Also memoizes mixin
|
||||
* applications.
|
||||
*
|
||||
* @memberof Polymer
|
||||
* @param {function} mixin ES6 class expression mixin to wrap
|
||||
* @return {function} Wrapped mixin that deduplicates and memoizes
|
||||
* mixin applications to base
|
||||
*/
|
||||
Polymer.dedupingMixin = function(mixin) {
|
||||
mixin = cachingMixin(mixin);
|
||||
|
Loading…
Reference in New Issue
Block a user