flynx/ImageGrid
1
1
Fork 0
mirror of https://github.com/flynx/ImageGrid.git synced 2026-01-03 17:01:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

added docs for splitData(...)...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2013-08-23 02:39:50 +04:00
parent 4d06451602
commit 69aabd6d07
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
ui/data.js
View File

@ -743,7 +743,7 @@ function dataFromImages(images){
// //
// XXX should we try and resolve gid collisions here?? // XXX should we try and resolve gid collisions here??
// ...don't think so... // ...don't think so...
// XXX should we check the version??? // XXX should we check the data version???
// XXX needs testing... // XXX needs testing...
function mergeData(a, b){ function mergeData(a, b){
var order = [] var order = []
@ -792,7 +792,22 @@ function mergeData(a, b){
} }
// XXX signature: splitData(data, gid1[, gid2[, ...]]) // Split the given data at gid1[, gid2[, ...]]
//
// This will return a list of data objects, each containing gids that
// are later than gidN and earlier or the same as gidN+1, preserving the
// ribbon structure.
//
// NOTE: if a given object does not contain any gid in ribbon N then that
// ribbon will be represented by an empty list.
// NOTE: the above makes the data objects not compatible with anything that
// expects the ribbon to have at least one gid.
// NOTE: this takes one or more gids.
// NOTE: this will not set .current fields.
// NOTE: this is the opposite of mergeData():
// mergeData(splitData(data, ...)) == data
// with the exception of .current
//
// XXX this is a bit brain-dead at the moment... // XXX this is a bit brain-dead at the moment...
// XXX do we need to check if supplied gids exist in data??? // XXX do we need to check if supplied gids exist in data???
function splitData(data, gid1){ function splitData(data, gid1){