From aff219c6ef17f9fbe919cafcad9929a9798c7d39 Mon Sep 17 00:00:00 2001 From: Galen Nickel Date: Thu, 4 Apr 2019 20:32:48 -0700 Subject: [PATCH] Fill in some parameter TODO's (#1962) --- libs/core/game.ts | 18 +++++++++--------- libs/core/images.cpp | 14 +++++++------- libs/core/input.cpp | 6 +++--- libs/core/led.cpp | 8 ++++---- libs/core/led.ts | 8 ++++---- libs/core/shims.d.ts | 28 ++++++++++++++-------------- 6 files changed, 41 insertions(+), 41 deletions(-) diff --git a/libs/core/game.ts b/libs/core/game.ts index 97f006f3..05e48269 100644 --- a/libs/core/game.ts +++ b/libs/core/game.ts @@ -402,7 +402,7 @@ namespace game { /** * If touching the edge of the stage and facing towards it, then turn away. - * @param this TODO + * @param this the sprite to check for bounce */ //% weight=18 help=game/if-on-edge-bounce //% blockId=game_sprite_bounce block="%sprite|if on edge, bounce" @@ -454,7 +454,7 @@ namespace game { /** * Turn the sprite - * @param this TODO + * @param this the sprite to trun * @param direction left or right * @param degrees angle in degrees to turn, eg: 45, 90, 180, 135 */ @@ -469,7 +469,7 @@ namespace game { /** * Turn to the right (clockwise) - * @param this TODO + * @param this the sprite to turn * @param degrees TODO */ public turnRight(degrees: number): void { @@ -478,7 +478,7 @@ namespace game { /** * Turn to the left (counter-clockwise) - * @param this TODO + * @param this the sprite to turn * @param degrees TODO */ public turnLeft(degrees: number): void { @@ -538,8 +538,8 @@ namespace game { /** * Set the direction of the current sprite, rounded to the nearest multiple of 45 - * @param this TODO - * @param degrees TODO + * @param this the sprite to set direction for + * @param degrees new direction in degrees */ //% parts="ledmatrix" public setDirection(degrees: number): void { @@ -614,8 +614,8 @@ namespace game { /** * Reports true if sprite has the same position as specified sprite - * @param this TODO - * @param other TODO + * @param this the sprite to check overlap or touch + * @param other the other sprite to check overlap or touch */ //% weight=20 help=game/is-touching //% blockId=game_sprite_touching_sprite block="is %sprite|touching %other" blockGap=8 @@ -625,7 +625,7 @@ namespace game { /** * Reports true if sprite is touching an edge - * @param this TODO + * @param this the sprite to check for an edge contact */ //% weight=19 help=game/is-touching-edge //% blockId=game_sprite_touching_edge block="is %sprite|touching edge" blockGap=8 diff --git a/libs/core/images.cpp b/libs/core/images.cpp index 4178122e..e303e13c 100644 --- a/libs/core/images.cpp +++ b/libs/core/images.cpp @@ -150,9 +150,9 @@ int height(Image i) { /** * 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" @@ -162,8 +162,8 @@ void setPixel(Image i, int x, int y, bool value) { /** * 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" @@ -172,8 +172,8 @@ bool pixel(Image i, int x, int y) { } /** - * 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" diff --git a/libs/core/input.cpp b/libs/core/input.cpp index 4f8bc21e..79ce2da3 100644 --- a/libs/core/input.cpp +++ b/libs/core/input.cpp @@ -276,7 +276,7 @@ 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 @@ -326,7 +326,7 @@ 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 @@ -341,7 +341,7 @@ 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 diff --git a/libs/core/led.cpp b/libs/core/led.cpp index 5eeffe75..5061ff31 100644 --- a/libs/core/led.cpp +++ b/libs/core/led.cpp @@ -47,8 +47,8 @@ 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 @@ -61,8 +61,8 @@ 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" diff --git a/libs/core/led.ts b/libs/core/led.ts index b317acf4..b526556e 100644 --- a/libs/core/led.ts +++ b/libs/core/led.ts @@ -55,8 +55,8 @@ /** * Toggles a particular pixel - * @param x TODO - * @param y TODO + * @param x pixel column + * @param y pixel row */ //% help=led/toggle weight=77 //% blockId=device_led_toggle block="toggle|x %x|y %y" icon="\uf204" blockGap=8 @@ -99,7 +99,7 @@ /** * Fades in the screen display. - * @param ms TODO + * @param ms fade time in milleseconds */ //% help=led/fade-in //% parts="ledmatrix" @@ -122,7 +122,7 @@ /** * Fades out the screen brightness. - * @param ms TODO + * @param ms fade time in milliseconds */ //% help=led/fade-out //% parts="ledmatrix" diff --git a/libs/core/shims.d.ts b/libs/core/shims.d.ts index 714ebacf..f5bc4595 100644 --- a/libs/core/shims.d.ts +++ b/libs/core/shims.d.ts @@ -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"