From fa58519c9ad72d722db855c1716eb5ba05bbd6c4 Mon Sep 17 00:00:00 2001 From: Alexander Marks Date: Fri, 20 Jul 2018 21:40:34 -0700 Subject: [PATCH] Annotate some internal classes as private. --- lib/elements/array-selector.js | 1 + lib/legacy/class.js | 1 + lib/legacy/legacy-element-mixin.js | 1 + lib/mixins/dir-mixin.js | 1 + lib/mixins/disable-upgrade-mixin.js | 2 ++ lib/mixins/element-mixin.js | 1 + lib/mixins/properties-mixin.js | 1 + lib/mixins/property-accessors.js | 1 + lib/mixins/property-effects.js | 1 + lib/mixins/strict-binding-parser.js | 1 + lib/utils/mixin.js | 1 + lib/utils/templatize.js | 10 +++++++++- 12 files changed, 21 insertions(+), 1 deletion(-) diff --git a/lib/elements/array-selector.js b/lib/elements/array-selector.js index c4926f52b9..f783dcefe9 100644 --- a/lib/elements/array-selector.js +++ b/lib/elements/array-selector.js @@ -39,6 +39,7 @@ let ArraySelectorMixin = dedupingMixin(superClass => { * @constructor * @extends {superClass} * @implements {Polymer_ElementMixin} + * @private */ let elementBase = ElementMixin(superClass); diff --git a/lib/legacy/class.js b/lib/legacy/class.js index e9ebc474d2..04c0ba38a8 100644 --- a/lib/legacy/class.js +++ b/lib/legacy/class.js @@ -139,6 +139,7 @@ function flattenBehaviors(behaviors, list, exclude) { */ function GenerateClassFromInfo(info, Base) { + /** @private */ class PolymerGenerated extends Base { static get properties() { diff --git a/lib/legacy/legacy-element-mixin.js b/lib/legacy/legacy-element-mixin.js index 59f4a2f308..5a6e1c030c 100644 --- a/lib/legacy/legacy-element-mixin.js +++ b/lib/legacy/legacy-element-mixin.js @@ -45,6 +45,7 @@ export const LegacyElementMixin = dedupingMixin((base) => { * @implements {Polymer_ElementMixin} * @implements {Polymer_GestureEventListeners} * @implements {Polymer_DirMixin} + * @private */ const legacyElementBase = DirMixin(GestureEventListeners(ElementMixin(base))); diff --git a/lib/mixins/dir-mixin.js b/lib/mixins/dir-mixin.js index 0e6d31e34f..89522aa935 100644 --- a/lib/mixins/dir-mixin.js +++ b/lib/mixins/dir-mixin.js @@ -90,6 +90,7 @@ export const DirMixin = dedupingMixin((base) => { * @constructor * @extends {base} * @implements {Polymer_PropertyAccessors} + * @private */ const elementBase = PropertyAccessors(base); diff --git a/lib/mixins/disable-upgrade-mixin.js b/lib/mixins/disable-upgrade-mixin.js index 3d008e836c..b7f46486e2 100644 --- a/lib/mixins/disable-upgrade-mixin.js +++ b/lib/mixins/disable-upgrade-mixin.js @@ -43,8 +43,10 @@ export const DisableUpgradeMixin = dedupingMixin((base) => { * @constructor * @extends {base} * @implements {Polymer_ElementMixin} + * @private */ const superClass = ElementMixin(base); + /** * @polymer * @mixinClass diff --git a/lib/mixins/element-mixin.js b/lib/mixins/element-mixin.js index c0b9b6d051..861d1b120f 100644 --- a/lib/mixins/element-mixin.js +++ b/lib/mixins/element-mixin.js @@ -92,6 +92,7 @@ export const ElementMixin = dedupingMixin(base => { * @extends {base} * @implements {Polymer_PropertyEffects} * @implements {Polymer_PropertiesMixin} + * @private */ const polymerElementBase = PropertiesMixin(PropertyEffects(base)); diff --git a/lib/mixins/properties-mixin.js b/lib/mixins/properties-mixin.js index 8a18d0d474..a6d25ae6e9 100644 --- a/lib/mixins/properties-mixin.js +++ b/lib/mixins/properties-mixin.js @@ -53,6 +53,7 @@ export const PropertiesMixin = dedupingMixin(superClass => { * @constructor * @extends {superClass} * @implements {Polymer_PropertiesChanged} + * @private */ const base = PropertiesChanged(superClass); diff --git a/lib/mixins/property-accessors.js b/lib/mixins/property-accessors.js index c00e1b4f76..a7683516ad 100644 --- a/lib/mixins/property-accessors.js +++ b/lib/mixins/property-accessors.js @@ -99,6 +99,7 @@ export const PropertyAccessors = dedupingMixin(superClass => { * @extends {superClass} * @implements {Polymer_PropertiesChanged} * @unrestricted + * @private */ const base = PropertiesChanged(superClass); diff --git a/lib/mixins/property-effects.js b/lib/mixins/property-effects.js index 8567df7d7e..22d6455b1c 100644 --- a/lib/mixins/property-effects.js +++ b/lib/mixins/property-effects.js @@ -1118,6 +1118,7 @@ export const PropertyEffects = dedupingMixin(superClass => { * @implements {Polymer_PropertyAccessors} * @implements {Polymer_TemplateStamp} * @unrestricted + * @private */ const propertyEffectsBase = TemplateStamp(PropertyAccessors(superClass)); diff --git a/lib/mixins/strict-binding-parser.js b/lib/mixins/strict-binding-parser.js index 6af6612f18..924c69c70f 100644 --- a/lib/mixins/strict-binding-parser.js +++ b/lib/mixins/strict-binding-parser.js @@ -122,6 +122,7 @@ const StrictBindingParser = dedupingMixin((base) => { * @constructor * @extends {base} * @implements {Polymer_PropertyEffects} + * @private */ const elementBase = PropertyEffects(base); diff --git a/lib/utils/mixin.js b/lib/utils/mixin.js index 45bf64f2f5..b62283b424 100644 --- a/lib/utils/mixin.js +++ b/lib/utils/mixin.js @@ -15,6 +15,7 @@ let dedupeId = 0; /** * @constructor * @extends {Function} + * @private */ function MixinFunction(){} /** @type {(WeakMap | undefined)} */ diff --git a/lib/utils/templatize.js b/lib/utils/templatize.js index 986a22334c..3fde57db87 100644 --- a/lib/utils/templatize.js +++ b/lib/utils/templatize.js @@ -17,9 +17,11 @@ import { MutableData } from '../mixins/mutable-data.js'; // class only because Babel (incorrectly) requires super() in the class // constructor even though no `this` is used and it returns an instance. let newInstance = null; + /** * @constructor * @extends {HTMLTemplateElement} + * @private */ function HTMLTemplateElementExtension() { return newInstance; } HTMLTemplateElementExtension.prototype = Object.create(HTMLTemplateElement.prototype, { @@ -28,16 +30,20 @@ HTMLTemplateElementExtension.prototype = Object.create(HTMLTemplateElement.proto writable: true } }); + /** * @constructor * @implements {Polymer_PropertyEffects} * @extends {HTMLTemplateElementExtension} + * @private */ const DataTemplate = PropertyEffects(HTMLTemplateElementExtension); + /** * @constructor * @implements {Polymer_MutableData} * @extends {DataTemplate} + * @private */ const MutableDataTemplate = MutableData(DataTemplate); @@ -49,8 +55,8 @@ function upgradeTemplate(template, constructor) { newInstance = null; } -// Base class for TemplateInstance's /** + * Base class for TemplateInstance. * @constructor * @implements {Polymer_PropertyEffects} */ @@ -264,6 +270,7 @@ TemplateInstanceBase.prototype.__hostProps; * @constructor * @extends {TemplateInstanceBase} * @implements {Polymer_MutableData} + * @private */ const MutableTemplateInstanceBase = MutableData(TemplateInstanceBase); @@ -307,6 +314,7 @@ function addPropagateEffects(template, templateInfo, options) { let klass = templateInfo.templatizeTemplateClass; if (!klass) { let base = options.mutableData ? MutableDataTemplate : DataTemplate; + /** @private */ klass = templateInfo.templatizeTemplateClass = class TemplatizedTemplate extends base {}; // Add template - >instances effects