Skip to content

Commit 4cb7f10

Browse files
committed
Update documentation
1 parent 26aee05 commit 4cb7f10

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/brainbrowser/surface-viewer/modules/rendering.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -354,16 +354,16 @@ BrainBrowser.SurfaceViewer.modules.rendering = function(viewer) {
354354
/**
355355
* @doc function
356356
* @name viewer.rendering:gridHelper
357-
* @param {number} where start the grid horizontally
358-
* @param {number} where end the grid horizontally
359-
* @param {number} ???
360-
* @param {number} ???
361-
* @param {object} a THREE color
357+
* @param {number} horizontal_from where start the grid horizontally
358+
* @param {number} horizontal_to where end the grid horizontally
359+
* @param {number} x1 where horizontal vertices start
360+
* @param {number} x2 where horizontal vertices end
361+
* @param {object} horizontal_color a THREE color
362362
* @param {number} where start the grid vertically
363363
* @param {number} where end the grid vertically
364-
* @param {number} ???
365-
* @param {number} ???
366-
* @param {object} a THREE color
364+
* @param {number} z1 where vertical vertices start
365+
* @param {number} z2 where horizontal vertices end
366+
* @param {object} vertical_color a THREE color
367367
* @param {number} step of the grid
368368
*
369369
* @returns {object} The grid itself.
@@ -372,7 +372,7 @@ BrainBrowser.SurfaceViewer.modules.rendering = function(viewer) {
372372
* ```js
373373
* var horizontal_color = new THREE.Color(0x000000);
374374
* var vertical_color = new THREE.Color(0xFF0000);
375-
* var gridXY = viewer.gridHelper( -100, 100, -100, 100, horizontal_color, -100, 100, 100, -100, vertical_color, 10)
375+
* var gridXY = viewer.gridHelper( -100, 100, -100, 100, horizontal_color, -100, 100, 100, -100, vertical_color, 10)
376376
* ```
377377
*
378378
*/

0 commit comments

Comments
 (0)