From 019a1ba59bdca127c81a941b8d302dae5895937b Mon Sep 17 00:00:00 2001 From: Peter Burns Date: Tue, 24 Apr 2018 16:54:00 -0700 Subject: [PATCH 1/7] First pass on 3.0 api docs. --- .gitignore | 3 + .../docs/api/classes/Polymer.Debouncer.html | 7 - .../Polymer.FlattenedNodesObserver.html | 7 - .../api/elements/Polymer.ArraySelector.html | 7 - .../api/elements/Polymer.CustomStyle.html | 7 - .../docs/api/elements/Polymer.DomBind.html | 7 - app/3.0/docs/api/elements/Polymer.DomIf.html | 7 - .../docs/api/elements/Polymer.DomModule.html | 7 - .../docs/api/elements/Polymer.DomRepeat.html | 7 - .../docs/api/elements/Polymer.Element.html | 7 - app/3.0/docs/api/elements/array-selector.html | 7 + app/3.0/docs/api/elements/custom-style.html | 7 + app/3.0/docs/api/elements/dom-bind.html | 7 + app/3.0/docs/api/elements/dom-if.html | 7 + app/3.0/docs/api/elements/dom-module.html | 7 + app/3.0/docs/api/elements/dom-repeat.html | 7 + app/3.0/docs/api/index.html | 476 +++++++++++++++- app/3.0/docs/api/legacy/class.html | 7 + .../docs/api/legacy/legacy-element-mixin.html | 7 + .../api/legacy/mutable-data-behavior.html | 7 + app/3.0/docs/api/legacy/polymer-fn.html | 7 + app/3.0/docs/api/legacy/polymer.dom.html | 7 + .../docs/api/legacy/templatizer-behavior.html | 7 + .../mixins/Polymer.ArraySelectorMixin.html | 7 - .../docs/api/mixins/Polymer.ElementMixin.html | 7 - .../mixins/Polymer.GestureEventListeners.html | 7 - .../mixins/Polymer.LegacyElementMixin.html | 7 - .../docs/api/mixins/Polymer.MutableData.html | 7 - .../mixins/Polymer.OptionalMutableData.html | 7 - .../api/mixins/Polymer.PropertyAccessors.html | 7 - .../api/mixins/Polymer.PropertyEffects.html | 7 - .../api/mixins/Polymer.TemplateStamp.html | 7 - app/3.0/docs/api/mixins/dir-mixin.html | 7 + .../api/mixins/disable-upgrade-mixin.html | 7 + app/3.0/docs/api/mixins/element-mixin.html | 7 + .../api/mixins/gesture-event-listeners.html | 7 + app/3.0/docs/api/mixins/mutable-data.html | 7 + .../docs/api/mixins/properties-changed.html | 7 + app/3.0/docs/api/mixins/properties-mixin.html | 7 + .../docs/api/mixins/property-accessors.html | 7 + app/3.0/docs/api/mixins/property-effects.html | 7 + .../api/mixins/strict-binding-parser.html | 7 + app/3.0/docs/api/mixins/template-stamp.html | 7 + .../api/namespaces/Polymer.ArraySplice.html | 7 - .../Polymer.Async.animationFrame.html | 7 - .../docs/api/namespaces/Polymer.Async.html | 7 - .../namespaces/Polymer.Async.idlePeriod.html | 7 - .../namespaces/Polymer.Async.microTask.html | 7 - .../api/namespaces/Polymer.Async.timeOut.html | 7 - .../docs/api/namespaces/Polymer.CaseMap.html | 7 - .../docs/api/namespaces/Polymer.Gestures.html | 7 - app/3.0/docs/api/namespaces/Polymer.Path.html | 7 - .../api/namespaces/Polymer.RenderStatus.html | 7 - .../api/namespaces/Polymer.ResolveUrl.html | 7 - .../api/namespaces/Polymer.StyleGather.html | 7 - .../api/namespaces/Polymer.Templatize.html | 7 - app/3.0/docs/api/namespaces/Polymer.dom.html | 7 - .../docs/api/namespaces/Polymer.settings.html | 7 - .../api/namespaces/Polymer.telemetry.html | 7 - app/3.0/docs/api/polymer-element.html | 7 + app/3.0/docs/api/utils/array-splice.html | 7 + app/3.0/docs/api/utils/case-map.html | 7 + app/3.0/docs/api/utils/debounce.html | 7 + .../api/utils/flattened-nodes-observer.html | 7 + app/3.0/docs/api/utils/flush.html | 7 + app/3.0/docs/api/utils/gestures.html | 7 + app/3.0/docs/api/utils/html-tag.html | 7 + app/3.0/docs/api/utils/import-href.html | 7 + app/3.0/docs/api/utils/mixin.html | 7 + app/3.0/docs/api/utils/path.html | 7 + app/3.0/docs/api/utils/render-status.html | 7 + app/3.0/docs/api/utils/resolve-url.html | 7 + app/3.0/docs/api/utils/settings.html | 7 + app/3.0/docs/api/utils/style-gather.html | 7 + app/3.0/docs/api/utils/templatize.html | 7 + package.json | 3 +- scripts/gen_and_summarize.js | 33 ++ scripts/generate_api_docs_1.js | 14 +- scripts/generate_api_docs_2.js | 14 +- scripts/generate_api_docs_3.js | 535 ++++++++++++++++++ scripts/summarize-analysis.js | 145 +++++ 81 files changed, 1479 insertions(+), 255 deletions(-) delete mode 100644 app/3.0/docs/api/classes/Polymer.Debouncer.html delete mode 100644 app/3.0/docs/api/classes/Polymer.FlattenedNodesObserver.html delete mode 100644 app/3.0/docs/api/elements/Polymer.ArraySelector.html delete mode 100644 app/3.0/docs/api/elements/Polymer.CustomStyle.html delete mode 100644 app/3.0/docs/api/elements/Polymer.DomBind.html delete mode 100644 app/3.0/docs/api/elements/Polymer.DomIf.html delete mode 100644 app/3.0/docs/api/elements/Polymer.DomModule.html delete mode 100644 app/3.0/docs/api/elements/Polymer.DomRepeat.html delete mode 100644 app/3.0/docs/api/elements/Polymer.Element.html create mode 100644 app/3.0/docs/api/elements/array-selector.html create mode 100644 app/3.0/docs/api/elements/custom-style.html create mode 100644 app/3.0/docs/api/elements/dom-bind.html create mode 100644 app/3.0/docs/api/elements/dom-if.html create mode 100644 app/3.0/docs/api/elements/dom-module.html create mode 100644 app/3.0/docs/api/elements/dom-repeat.html create mode 100644 app/3.0/docs/api/legacy/class.html create mode 100644 app/3.0/docs/api/legacy/legacy-element-mixin.html create mode 100644 app/3.0/docs/api/legacy/mutable-data-behavior.html create mode 100644 app/3.0/docs/api/legacy/polymer-fn.html create mode 100644 app/3.0/docs/api/legacy/polymer.dom.html create mode 100644 app/3.0/docs/api/legacy/templatizer-behavior.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.ArraySelectorMixin.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.ElementMixin.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.GestureEventListeners.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.LegacyElementMixin.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.MutableData.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.OptionalMutableData.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.PropertyAccessors.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.PropertyEffects.html delete mode 100644 app/3.0/docs/api/mixins/Polymer.TemplateStamp.html create mode 100644 app/3.0/docs/api/mixins/dir-mixin.html create mode 100644 app/3.0/docs/api/mixins/disable-upgrade-mixin.html create mode 100644 app/3.0/docs/api/mixins/element-mixin.html create mode 100644 app/3.0/docs/api/mixins/gesture-event-listeners.html create mode 100644 app/3.0/docs/api/mixins/mutable-data.html create mode 100644 app/3.0/docs/api/mixins/properties-changed.html create mode 100644 app/3.0/docs/api/mixins/properties-mixin.html create mode 100644 app/3.0/docs/api/mixins/property-accessors.html create mode 100644 app/3.0/docs/api/mixins/property-effects.html create mode 100644 app/3.0/docs/api/mixins/strict-binding-parser.html create mode 100644 app/3.0/docs/api/mixins/template-stamp.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.ArraySplice.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Async.animationFrame.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Async.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Async.idlePeriod.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Async.microTask.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Async.timeOut.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.CaseMap.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Gestures.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Path.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.RenderStatus.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.ResolveUrl.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.StyleGather.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.Templatize.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.dom.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.settings.html delete mode 100644 app/3.0/docs/api/namespaces/Polymer.telemetry.html create mode 100644 app/3.0/docs/api/polymer-element.html create mode 100644 app/3.0/docs/api/utils/array-splice.html create mode 100644 app/3.0/docs/api/utils/case-map.html create mode 100644 app/3.0/docs/api/utils/debounce.html create mode 100644 app/3.0/docs/api/utils/flattened-nodes-observer.html create mode 100644 app/3.0/docs/api/utils/flush.html create mode 100644 app/3.0/docs/api/utils/gestures.html create mode 100644 app/3.0/docs/api/utils/html-tag.html create mode 100644 app/3.0/docs/api/utils/import-href.html create mode 100644 app/3.0/docs/api/utils/mixin.html create mode 100644 app/3.0/docs/api/utils/path.html create mode 100644 app/3.0/docs/api/utils/render-status.html create mode 100644 app/3.0/docs/api/utils/resolve-url.html create mode 100644 app/3.0/docs/api/utils/settings.html create mode 100644 app/3.0/docs/api/utils/style-gather.html create mode 100644 app/3.0/docs/api/utils/templatize.html create mode 100644 scripts/gen_and_summarize.js create mode 100644 scripts/generate_api_docs_3.js create mode 100644 scripts/summarize-analysis.js diff --git a/.gitignore b/.gitignore index f673b87d58..bcd6f8be2e 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,6 @@ build # Dev directories /app/bower_components /node_modules +/scripts/node_modules +/scripts/temp +/scripts/*_analysis.json diff --git a/app/3.0/docs/api/classes/Polymer.Debouncer.html b/app/3.0/docs/api/classes/Polymer.Debouncer.html deleted file mode 100644 index e922b276b2..0000000000 --- a/app/3.0/docs/api/classes/Polymer.Debouncer.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = "Polymer.Debouncer" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - Polymer.Debouncer{% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/classes/Polymer.FlattenedNodesObserver.html b/app/3.0/docs/api/classes/Polymer.FlattenedNodesObserver.html deleted file mode 100644 index 71ddbdb917..0000000000 --- a/app/3.0/docs/api/classes/Polymer.FlattenedNodesObserver.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = "Polymer.FlattenedNodesObserver" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - Polymer.FlattenedNodesObserver{% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.ArraySelector.html b/app/3.0/docs/api/elements/Polymer.ArraySelector.html deleted file mode 100644 index d02223dbcc..0000000000 --- a/app/3.0/docs/api/elements/Polymer.ArraySelector.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.ArraySelector)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.ArraySelector){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.CustomStyle.html b/app/3.0/docs/api/elements/Polymer.CustomStyle.html deleted file mode 100644 index 7b9d82b100..0000000000 --- a/app/3.0/docs/api/elements/Polymer.CustomStyle.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.CustomStyle)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.CustomStyle){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.DomBind.html b/app/3.0/docs/api/elements/Polymer.DomBind.html deleted file mode 100644 index 689ab58aee..0000000000 --- a/app/3.0/docs/api/elements/Polymer.DomBind.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.DomBind)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.DomBind){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.DomIf.html b/app/3.0/docs/api/elements/Polymer.DomIf.html deleted file mode 100644 index ccee359162..0000000000 --- a/app/3.0/docs/api/elements/Polymer.DomIf.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.DomIf)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.DomIf){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.DomModule.html b/app/3.0/docs/api/elements/Polymer.DomModule.html deleted file mode 100644 index 6b783bc658..0000000000 --- a/app/3.0/docs/api/elements/Polymer.DomModule.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.DomModule)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.DomModule){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.DomRepeat.html b/app/3.0/docs/api/elements/Polymer.DomRepeat.html deleted file mode 100644 index 61a60dd668..0000000000 --- a/app/3.0/docs/api/elements/Polymer.DomRepeat.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = " (Polymer.DomRepeat)" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - (Polymer.DomRepeat){% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/Polymer.Element.html b/app/3.0/docs/api/elements/Polymer.Element.html deleted file mode 100644 index a469c09620..0000000000 --- a/app/3.0/docs/api/elements/Polymer.Element.html +++ /dev/null @@ -1,7 +0,0 @@ -{% set markdown = "true" %} -{% set title = "Polymer.Element" %} -{% extends "templates/base-devguide.html" %} -{% block title %} API Reference - Polymer.Element{% endblock %} -{% block content %} - -{% endblock %} \ No newline at end of file diff --git a/app/3.0/docs/api/elements/array-selector.html b/app/3.0/docs/api/elements/array-selector.html new file mode 100644 index 0000000000..de5aa669a1 --- /dev/null +++ b/app/3.0/docs/api/elements/array-selector.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/array-selector.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/array-selector.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/elements/custom-style.html b/app/3.0/docs/api/elements/custom-style.html new file mode 100644 index 0000000000..dc6f85f161 --- /dev/null +++ b/app/3.0/docs/api/elements/custom-style.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/custom-style.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/custom-style.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/elements/dom-bind.html b/app/3.0/docs/api/elements/dom-bind.html new file mode 100644 index 0000000000..283e04830b --- /dev/null +++ b/app/3.0/docs/api/elements/dom-bind.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/dom-bind.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/dom-bind.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/elements/dom-if.html b/app/3.0/docs/api/elements/dom-if.html new file mode 100644 index 0000000000..bdd351edb8 --- /dev/null +++ b/app/3.0/docs/api/elements/dom-if.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/dom-if.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/dom-if.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/elements/dom-module.html b/app/3.0/docs/api/elements/dom-module.html new file mode 100644 index 0000000000..a75993b108 --- /dev/null +++ b/app/3.0/docs/api/elements/dom-module.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/dom-module.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/dom-module.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/elements/dom-repeat.html b/app/3.0/docs/api/elements/dom-repeat.html new file mode 100644 index 0000000000..1176256800 --- /dev/null +++ b/app/3.0/docs/api/elements/dom-repeat.html @@ -0,0 +1,7 @@ +{% set markdown = "true" %} +{% set title = "lib/elements/dom-repeat.js" %} +{% extends "templates/base-devguide.html" %} +{% block title %} API Reference for lib/elements/dom-repeat.js{% endblock %} +{% block content %} + +{% endblock %} diff --git a/app/3.0/docs/api/index.html b/app/3.0/docs/api/index.html index c2c395bf85..9f58c8954c 100644 --- a/app/3.0/docs/api/index.html +++ b/app/3.0/docs/api/index.html @@ -1,7 +1,475 @@ {% set markdown = "true" %} -{% set title = "Polymer" %} +{% set title = "Polymer API Docs" %} {% extends "templates/base-devguide.html" %} -{% block title %} API Reference - Polymer{% endblock %} +{% block title %} Polymer API Reference {% endblock %} {% block content %} - -{% endblock %} \ No newline at end of file + + +
+
+
PolymerElement
+
+ Base class that provides the core API for Polymer's meta-programming + features including template stamping, data-binding, attribute + deserialization, and property change observation. +
+
+ + + +
+

elements

+ + +
+
array-selector.js
+
+ + Module providing tools for maintaining a mapping between a master + `items` array and a subset of those items that are selected. + +
+
+ + + +
+
custom-style.js
+
+ Custom element for defining styles in the main document that can + take advantage of Polymer's style scoping and custom properties shims. +
+
+ + + +
+
dom-bind.js
+
+ Custom element to allow using Polymer's template features (data + binding, declarative event listeners, etc.) in the main document. +
+
+ + + +
+
dom-if.js
+
+ Custom element that conditionally stamps and hides or removes + template content based on a boolean flag. +
+
+ + + +
+
dom-module.js
+
+ Custom element that provides a registry of relocatable DOM content + by `id` that is agnostic to bundling. +
+
+ + + +
+
dom-repeat.js
+
+ Custom element for stamping instance of a template bound to + items in an array. +
+
+ +
+ + + + +
+

mixins

+ + +
+
dir-mixin.js
+
+ + Mixin that allows elements to use the `:dir` CSS Selector to + have text direction specific styling. + +
+
+ + + +
+
disable-upgrade-mixin.js
+
+ + Mixin that allows the element to boot up in a non-enabled + state when the `disable-upgrade` attribute is present. This mixin is + designed to be used with element classes like PolymerElement that perform + initial startup work when they are first connected. + +
+
+ + + +
+
element-mixin.js
+
+ + Element class mixin that provides the core API for Polymer's + meta-programming features. Also provides some telemetry APIs. + +
+
+ + + +
+
gesture-event-listeners.js
+
+ Element class mixin that provides API for adding Polymer's + cross-platform +gesture events to nodes +
+
+ + + +
+
mutable-data.js
+
+ + Mixins for skipping strict dirty checking of objects and arrays. + +
+
+ + + +
+
properties-changed.js
+
+ Element class mixin for reacting to property changes from + generated property accessors. +
+
+ + + +
+
properties-mixin.js
+
+ Mixin that provides a minimal starting point for using +the PropertiesChanged mixin by providing a declarative `properties` object. +
+
+ + + +
+
property-accessors.js
+
+ Element class mixin for reacting to property changes from + generated property accessors. +
+
+ + + +
+
property-effects.js
+
+ Element class mixin that provides meta-programming for Polymer's +template binding and data observation system. +
+
+ + + +
+
strict-binding-parser.js
+
+ Mixin that parses binding expressions and generates corresponding metadata. +
+
+ + + +
+
template-stamp.js
+
+ Element class mixin that provides basic template parsing and stamping +
+
+ +
+ + + + +
+

utils

+ + +
+
array-splice.js
+
+ Computes an array of splice records indicating the minimum edits +required to transform the `previous` array into the `current` array. +
+
+ + + +
+
case-map.js
+
+ + Module that provides utilities for converting between "dash-case" + and "camelCase". + +
+
+ + + +
+
debounce.js
+
+ Collapse multiple callbacks into one invocation after a timer. +
+
+ + + +
+
flattened-nodes-observer.js
+
+ Class that listens for changes (additions or removals) to +"flattened nodes" on a given `node`. +
+
+ + + +
+
flush.js
+
+ + Forces several classes of asynchronously queued tasks to synchronously + execute. + +
+
+ + + +
+
gestures.js
+
+ + Module for adding cross-platform gesture event listeners. + +
+
+ + + +
+
html-tag.js
+
+ + A template literal tag that creates an HTML `