scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-03 19:45:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix docs issues with Item#matches()

Browse source
This commit is contained in:
Jürg Lehni 2014-10-18 13:40:36 +02:00
parent 3be1e481e9
commit e7fd751765
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/item/Item.js
View file

@ -1775,23 +1775,20 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
},
/**
* @name Item#matches
*
* {@grouptitle Fetching and matching items}
*
* Checks whether the item matches the criteria described by the given
* object, by iterating over all of its properties and matching against
* their values through {@link #matches(name, compare)}.
*
* @name #matches
* @function
*
* @see Project#getItems(match)
* @param {Object} match the criteria to match against.
* @return {@true if the item matches all the criteria}
*/
/**
* @name Item#matches
*
* {@grouptitle Fetching and matching items}
*
* Checks whether the item matches the given criteria. Extended matching is
* possible by providing a compare function or a regular expression.
* Matching points, colors only work as a comparison of the full object, not
@ -1799,6 +1796,9 @@ var Item = Base.extend(Emitter, /** @lends Item# */{
* points with that x-value). Partial matching does work for
* {@link Item#data}.
*
* @name #matches
* @function
*
* @see Project#getItems(match)
* @param {String} name the name of the state to match against.
* @param {Object} compare the value, function or regular expression to