Fill in some parameter TODO's (#1962)

This commit is contained in:
Galen Nickel
2019-04-04 20:32:48 -07:00
committed by Peli de Halleux
parent aa51b7e014
commit aff219c6ef
6 changed files with 41 additions and 41 deletions

28
libs/core/shims.d.ts vendored
View File

@ -97,9 +97,9 @@ declare interface Image {
/**
* Set a pixel state at position ``(x,y)``
* @param x TODO
* @param y TODO
* @param value TODO
* @param x pixel column
* @param y pixel row
* @param value pixel state
*/
//% help=images/set-pixel
//% parts="ledmatrix" shim=ImageMethods::setPixel
@ -107,16 +107,16 @@ declare interface Image {
/**
* Get the pixel state at position ``(x,y)``
* @param x TODO
* @param y TODO
* @param x pixel column
* @param y pixel row
*/
//% help=images/pixel
//% parts="ledmatrix" shim=ImageMethods::pixel
pixel(x: int32, y: int32): boolean;
/**
* Shows a particular frame of the image strip.
* @param frame TODO
* Show a particular frame of the image strip.
* @param frame image frame to show
*/
//% weight=70 help=images/show-frame
//% parts="ledmatrix" interval.defl=400 shim=ImageMethods::showFrame
@ -279,7 +279,7 @@ declare namespace input {
/**
* Get the acceleration value in milli-gravitys (when the board is laying flat with the screen up, x=0, y=0 and z=-1024)
* @param dimension TODO
* @param dimension x, y, or z dimension, eg: Dimension.X
*/
//% help=input/acceleration weight=58
//% blockId=device_acceleration block="acceleration (mg)|%NAME" blockGap=8
@ -314,7 +314,7 @@ declare namespace input {
/**
* The pitch or roll of the device, rotation along the ``x-axis`` or ``y-axis``, in degrees.
* @param kind TODO
* @param kind pitch or roll
*/
//% help=input/rotation weight=52
//% blockId=device_get_rotation block="rotation (°)|%NAME" blockGap=8
@ -323,7 +323,7 @@ declare namespace input {
/**
* Get the magnetic force value in ``micro-Teslas`` (``µT``). This function is not supported in the simulator.
* @param dimension TODO
* @param dimension the x, y, or z dimension, eg: Dimension.X
*/
//% help=input/magnetic-force weight=51
//% blockId=device_get_magnetic_force block="magnetic force (µT)|%NAME" blockGap=8
@ -491,8 +491,8 @@ declare namespace led {
/**
* Turn off the specified LED using x, y coordinates (x is horizontal, y is vertical). (0,0) is upper left.
* @param x TODO
* @param y TODO
* @param x the horizontal coordinate of the LED
* @param y the vertical coordinate of the LED
*/
//% help=led/unplot weight=77
//% blockId=device_unplot block="unplot|x %x|y %y" blockGap=8
@ -503,8 +503,8 @@ declare namespace led {
/**
* Get the on/off state of the specified LED using x, y coordinates. (0,0) is upper left.
* @param x TODO
* @param y TODO
* @param x the horizontal coordinate of the LED
* @param y the vertical coordinate of the LED
*/
//% help=led/point weight=76
//% blockId=device_point block="point|x %x|y %y"