Remove unused @method

Polymer · Apr 14, 2017 · 6d63613 · 6d63613
1 parent 8cab18b
commit 6d63613
Show file tree

Hide file tree

Showing 11 changed files with 0 additions and 64 deletions.
diff --git a/lib/elements/array-selector.html b/lib/elements/array-selector.html
@@ -193,7 +193,6 @@
       /**
        * Clears the selection state.
        *
-       * @method clearSelection
        */
       clearSelection() {
         // Unbind previous selection
@@ -211,7 +210,6 @@
       /**
        * Returns whether the item is currently selected.
        *
-       * @method isSelected
        * @param {*} item Item from `items` array to test
        * @return {boolean} Whether the item is selected
        */
@@ -222,7 +220,6 @@
       /**
        * Returns whether the item is currently selected.
        *
-       * @method isSelected
        * @param {*} idx Index from `items` array to test
        * @return {boolean} Whether the item is selected
        */
@@ -252,7 +249,6 @@
       /**
        * Deselects the given item if it is already selected.
        *
-       * @method deselect
        * @param {*} item Item from `items` array to deselect
        */
       deselect(item) {
@@ -275,7 +271,6 @@
       /**
        * Deselects the given index if it is already selected.
        *
-       * @method deselect
        * @param {number} idx Index from `items` array to deselect
        */
       deselectIndex(idx) {
@@ -286,7 +281,6 @@
        * Selects the given item.  When `toggle` is true, this will automatically
        * deselect the item if already selected.
        *
-       * @method select
        * @param {*} item Item from `items` array to select
        */
       select(item) {
@@ -297,7 +291,6 @@
        * Selects the given index.  When `toggle` is true, this will automatically
        * deselect the item if already selected.
        *
-       * @method select
        * @param {number} idx Index from `items` array to select
        */
       selectIndex(idx) {

diff --git a/lib/elements/dom-module.html b/lib/elements/dom-module.html
@@ -56,7 +56,6 @@
     /**
      * Retrieves the element specified by the css `selector` in the module
      * registered by `id`. For example, this.import('foo', 'img');
-     * @method import
      * @param {string} id The id of the dom-module in which to search.
      * @param {string=} selector The css selector by which to find the element.
      * @return {Element} Returns the element which matches `selector` in the
@@ -108,7 +107,6 @@
      * Registers the dom-module at a given id. This method should only be called
      * when a dom-module is imperatively created. For
      * example, `document.createElement('dom-module').register('foo')`.
-     * @method register
      * @param {string=} id The id at which to register the dom-module.
      */
     register(id) {

diff --git a/lib/elements/dom-repeat.html b/lib/elements/dom-repeat.html
@@ -626,7 +626,6 @@
      * `modelForElement(el).set('item.<sub-prop>', value)`
      * should be used.
      *
-     * @method itemForElement
      * @param {HTMLElement} el Element for which to return the item.
      * @return {*} Item associated with the element.
      */
@@ -640,7 +639,6 @@
      * If `sort` is provided, the index will reflect the sorted order (rather
      * than the original array order).
      *
-     * @method indexForElement
      * @param {HTMLElement} el Element for which to return the index.
      * @return {*} Row index associated with the element (note this may
      *   not correspond to the array index if a user `sort` is applied).
@@ -663,7 +661,6 @@
      *     model.set('item.checked', true);
      *   }
      *
-     * @method modelForElement
      * @param {HTMLElement} el Element for which to return a template model.
      * @return {TemplateInstanceBase} Model representing the binding scope for
      *   the element.

diff --git a/lib/legacy/legacy-element-mixin.html b/lib/legacy/legacy-element-mixin.html
@@ -230,7 +230,6 @@
        * Copies own properties (including accessor descriptors) from a source
        * object to a target object.
        *
-       * @method extend
        * @param {Object} prototype Target object to copy properties to.
        * @param {Object} api Source object to copy properties from.
        * @return {Object} prototype object that was passed as first argument.
@@ -256,7 +255,6 @@
        * properties.  To ensure only `ownProperties` are copied from source
        * to target and that accessor implementations are copied, use `extend`.
        *
-       * @method mixin
        * @param {Object} target Target object to copy properties to.
        * @param {Object} source Source object to copy properties from.
        * @return {Object} Target object that was passed as first argument.
@@ -292,7 +290,6 @@
        * Calls `importNode` on the `content` of the `template` specified and
        * returns a document fragment containing the imported content.
        *
-       * @method instanceTemplate
        * @param {HTMLTemplateElement} template HTML template element to instance.
        * @return {DocumentFragment} Document fragment containing the imported
        *   template content.
@@ -309,7 +306,6 @@
       /**
        * Dispatches a custom event with an optional detail value.
        *
-       * @method fire
        * @param {string} type Name of event type.
        * @param {*=} detail Detail value containing event-specific
        *   payload.
@@ -337,7 +333,6 @@
        * Convenience method to add an event listener on a given element,
        * late bound to a named method on this element.
        *
-       * @method listen
        * @param {Element} node Element to add event listener to.
        * @param {string} eventName Name of event to listen for.
        * @param {string} methodName Name of handler method on `this` to call.
@@ -362,7 +357,6 @@
        * Convenience method to remove an event listener from a given element,
        * late bound to a named method on this element.
        *
-       * @method unlisten
        * @param {Element} node Element to remove event listener from.
        * @param {string} eventName Name of event to stop listening to.
        * @param {string} methodName Name of handler method on `this` to not call
@@ -388,7 +382,6 @@
        *   - 'y': scroll only in the 'y' direction
        *   - 'none': disable scrolling for this node
        *
-       * @method setScrollDirection
        * @param {string=} direction Direction to allow scrolling
        * Defaults to `all`.
        * @param {HTMLElement=} node Element to apply scroll direction setting.
@@ -404,7 +397,6 @@
        *
        * This function calls `Polymer.dom(this.root).querySelector(slctr)`.
        *
-       * @method $$
        * @param {string} slctr Selector to run on this local DOM scope
        * @return {Element} Element found by the selector, or null if not found.
        */
@@ -429,7 +421,6 @@
        * a user should call `distributeContent` if distribution has been
        * invalidated due to an element being added or removed from the shadowRoot
        * that contains an insertion point (<slot>) inside its subtree.
-       * @method distributeContent
        */
       distributeContent() {
         if (window.ShadyDOM && this.shadowRoot) {
@@ -443,7 +434,6 @@
        * any `<content>` elements are replaced with the list of nodes distributed
        * to the `<content>`, the result of its `getDistributedNodes` method.
        *
-       * @method getEffectiveChildNodes
        * @return {Array<Node>} List of effctive child nodes.
        */
       getEffectiveChildNodes() {
@@ -454,7 +444,6 @@
        * Returns a list of nodes distributed within this element that match
        * `selector`. These can be dom children or elements distributed to
        * children that are insertion points.
-       * @method queryDistributedElements
        * @param {string} selector Selector to run.
        * @return {Array<Node>} List of distributed elements that match selector.
        */
@@ -468,7 +457,6 @@
        * any `<content>` elements are replaced with the list of elements
        * distributed to the `<content>`.
        *
-       * @method getEffectiveChildren
        * @return {Array<Node>} List of effctive children.
        */
       getEffectiveChildren() {
@@ -483,7 +471,6 @@
        * text content's of the element's effective childNodes (the elements
        * returned by <a href="#getEffectiveChildNodes>getEffectiveChildNodes</a>.
        *
-       * @method getEffectiveTextContent
        * @return {string} List of effctive children.
        */
       getEffectiveTextContent() {
@@ -501,7 +488,6 @@
        * Returns the first effective childNode within this element that
        * match `selector`. These can be dom child nodes or elements distributed
        * to children that are insertion points.
-       * @method queryEffectiveChildren
        * @param {string} selector Selector to run.
        * @return {Object<Node>} First effective child node that matches selector.
        */
@@ -514,7 +500,6 @@
        * Returns a list of effective childNodes within this element that
        * match `selector`. These can be dom child nodes or elements distributed
        * to children that are insertion points.
-       * @method queryEffectiveChildren
        * @param {string} selector Selector to run.
        * @return {Array<Node>} List of effective child nodes that match selector.
        */
@@ -528,7 +513,6 @@
        * If this element contains more than one `<slot>` in its local DOM,
        * an optional selector may be passed to choose the desired content.
        *
-       * @method getContentChildNodes
        * @param {string=} slctr CSS selector to choose the desired
        *   `<slot>`.  Defaults to `content`.
        * @return {Array<Node>} List of distributed nodes for the `<slot>`.
@@ -547,7 +531,6 @@
        * content.  This method differs from `getContentChildNodes` in that only
        * elements are returned.
        *
-       * @method getContentChildNodes
        * @param {string=} slctr CSS selector to choose the desired
        *   `<content>`.  Defaults to `content`.
        * @return {Array<HTMLElement>} List of distributed nodes for the
@@ -562,7 +545,6 @@
       /**
        * Checks whether an element is in this element's light DOM tree.
        *
-       * @method isLightDescendant
        * @param {?Node} node The element to be checked.
        * @return {boolean} true if node is in this element's light DOM tree.
        */
@@ -574,7 +556,6 @@
       /**
        * Checks whether an element is in this element's local DOM tree.
        *
-       * @method isLocalDescendant
        * @param {HTMLElement=} node The element to be checked.
        * @return {boolean} true if node is in this element's local DOM tree.
        */
@@ -611,7 +592,6 @@
        *       } 100);
        *     }
        *
-       * @method debounce
        * @param {string} jobName String to indentify the debounce job.
        * @param {function()} callback Function that is called (with `this`
        *   context) when the wait time elapses.
@@ -634,7 +614,6 @@
       /**
        * Returns whether a named debouncer is active.
        *
-       * @method isDebouncerActive
        * @param {string} jobName The name of the debouncer started with `debounce`
        * @return {boolean} Whether the debouncer is active (has not yet fired).
        */
@@ -647,7 +626,6 @@
       /**
        * Immediately calls the debouncer `callback` and inactivates it.
        *
-       * @method flushDebouncer
        * @param {string} jobName The name of the debouncer started with `debounce`
        */
       flushDebouncer(jobName) {
@@ -661,7 +639,6 @@
       /**
        * Cancels an active debouncer.  The `callback` will not be called.
        *
-       * @method cancelDebouncer
        * @param {string} jobName The name of the debouncer started with `debounce`
        */
       cancelDebouncer(jobName) {
@@ -678,7 +655,6 @@
        * By default (if no waitTime is specified), async callbacks are run at
        * microtask timing, which will occur before paint.
        *
-       * @method async
        * @param {Function} callback The callback function to run, bound to `this`.
        * @param {number=} waitTime Time to wait before calling the
        *   `callback`.  If unspecified or 0, the callback will be run at microtask
@@ -693,7 +669,6 @@
       /**
        * Cancels an async operation started with `async`.
        *
-       * @method cancelAsync
        * @param {number} handle Handle returned from original `async` call to
        *   cancel.
        */
@@ -707,7 +682,6 @@
       /**
        * Convenience method for creating an element and configuring it.
        *
-       * @method create
        * @param {string} tag HTML element tag to create.
        * @param {Object} props Object of properties to configure on the
        *    instance.
@@ -735,7 +709,6 @@
        * In the `onload` callback, the `import` property of the `link`
        * element will contain the imported document contents.
        *
-       * @method importHref
        * @param {string} href URL to document to load.
        * @param {Function} onload Callback to notify when an import successfully
        *   loaded.
@@ -755,7 +728,6 @@
        * Polyfill for Element.prototype.matches, which is sometimes still
        * prefixed.
        *
-       * @method elementMatches
        * @param {string} selector Selector to test.
        * @param {Element=} node Element to test the selector against.
        * @return {boolean} Whether the element matches the selector.
@@ -767,7 +739,6 @@
       /**
        * Toggles an HTML attribute on or off.
        *
-       * @method toggleAttribute
        * @param {string} name HTML attribute name
        * @param {boolean=} bool Boolean to force the attribute on or off.
        *    When unspecified, the state of the attribute will be reversed.
@@ -789,7 +760,6 @@
       /**
        * Toggles a CSS class on or off.
        *
-       * @method toggleClass
        * @param {string} name CSS class name
        * @param {boolean=} bool Boolean to force the class on or off.
        *    When unspecified, the state of the class will be reversed.
@@ -824,7 +794,6 @@
        * Cross-platform helper for setting an element's CSS `translate3d`
        * property.
        *
-       * @method translate3d
        * @param {number} x X offset.
        * @param {number} y Y offset.
        * @param {number} z Z offset.
@@ -846,7 +815,6 @@
        * If the array is passed directly, **no change
        * notification is generated**.
        *
-       * @method arrayDelete
        * @param {string | !Array<number|string>} arrayOrPath Path to array from which to remove the item
        *   (or the array itself).
        * @param {*} item Item to remove.

diff --git a/lib/legacy/templatizer-behavior.html b/lib/legacy/templatizer-behavior.html
@@ -121,7 +121,6 @@
        * instance the element is contained in.  A template model should be used
        * to manipulate data associated with this template instance.
        *
-       * @method modelForElement
        * @param {HTMLElement} el Element for which to return a template model.
        * @return {TemplateInstanceBase} Model representing the binding scope for
        *   the element.

diff --git a/lib/mixins/element-mixin.html b/lib/mixins/element-mixin.html
@@ -677,7 +677,6 @@
        * However, this method may be overridden to allow an element
        * to put its dom in another location.
        *
-       * @method _attachDom
        * @throws {Error}
        * @suppress {missingReturn}
        * @param {NodeList} dom to attach to the element.