Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I document a string double array in JSDoc?

I can't seem to find an example for this. But I have a string double array (table cell data), and I want to document it in my JSDoc.

Compiler doesn't seem to like this:

/**    
 * @param {cells: [[String]]} tableData
 */

And it doesn't have anything particularly nice to say about this:

/**    
 * @param {cells: String[][]} tableData
 */
like image 359
Oliver Watkins Avatar asked May 28 '13 09:05

Oliver Watkins


1 Answers

how about this:

 /**    
  * @param  {Object<Array<String>>}  tableData
  */

reference: http://wiki.servoy.com/display/public/DOCS/Annotating+JavaScript+using+JSDoc#AnnotatingJavaScriptusingJSDoc-TypeExpression

like image 95
Ruben Verschueren Avatar answered Oct 16 '22 20:10

Ruben Verschueren