Skip to content

Instantly share code, notes, and snippets.

@avishaan
Created October 13, 2016 04:32
Show Gist options
  • Save avishaan/52d76e7e0fe57337db38d53bf63b9897 to your computer and use it in GitHub Desktop.
Save avishaan/52d76e7e0fe57337db38d53bf63b9897 to your computer and use it in GitHub Desktop.
"complex" jsdoc example
/**
* sort data
*
* @param {String[]} data - data points
* @param {String[]} labels - labels in same order as data points
* @param {Object} options - labels in same order as data points
* @param {Number} sort - direction to short (ascending, descending)
* @return {Object} sorted - sortedData object
* @return {Number[]} sorted.data - data sorted in order
* @return {String[]} sorted.labels - labels for data returned in matching order
* @return {Number[]} sorted.sortIndex - sorted index of how the array was sorted
*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment