c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fill in some parameter TODO's (#1962)

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

18
libs/core/game.ts
View File

@@ -402,7 +402,7 @@ namespace game {
/** /**
* If touching the edge of the stage and facing towards it, then turn away. * 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 //% weight=18 help=game/if-on-edge-bounce
//% blockId=game_sprite_bounce block="%sprite|if on edge, bounce" //% blockId=game_sprite_bounce block="%sprite|if on edge, bounce"
@@ -454,7 +454,7 @@ namespace game {
/** /**
* Turn the sprite * Turn the sprite
* @param this TODO * @param this the sprite to trun
* @param direction left or right * @param direction left or right
* @param degrees angle in degrees to turn, eg: 45, 90, 180, 135 * @param degrees angle in degrees to turn, eg: 45, 90, 180, 135
*/ */
@@ -469,7 +469,7 @@ namespace game {
/** /**
* Turn to the right (clockwise) * Turn to the right (clockwise)
* @param this TODO * @param this the sprite to turn
* @param degrees TODO * @param degrees TODO
*/ */
public turnRight(degrees: number): void { public turnRight(degrees: number): void {
@@ -478,7 +478,7 @@ namespace game {
/** /**
* Turn to the left (counter-clockwise) * Turn to the left (counter-clockwise)
* @param this TODO * @param this the sprite to turn
* @param degrees TODO * @param degrees TODO
*/ */
public turnLeft(degrees: number): void { 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 * Set the direction of the current sprite, rounded to the nearest multiple of 45
* @param this TODO * @param this the sprite to set direction for
* @param degrees TODO * @param degrees new direction in degrees
*/ */
//% parts="ledmatrix" //% parts="ledmatrix"
public setDirection(degrees: number): void { public setDirection(degrees: number): void {
@@ -614,8 +614,8 @@ namespace game {
/** /**
* Reports true if sprite has the same position as specified sprite * Reports true if sprite has the same position as specified sprite
* @param this TODO * @param this the sprite to check overlap or touch
* @param other TODO * @param other the other sprite to check overlap or touch
*/ */
//% weight=20 help=game/is-touching //% weight=20 help=game/is-touching
//% blockId=game_sprite_touching_sprite block="is %sprite|touching %other" blockGap=8 //% 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 * 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 //% weight=19 help=game/is-touching-edge
//% blockId=game_sprite_touching_edge block="is %sprite|touching edge" blockGap=8 //% blockId=game_sprite_touching_edge block="is %sprite|touching edge" blockGap=8

14
libs/core/images.cpp
View File

@@ -150,9 +150,9 @@ int height(Image i) {
/** /**
* Set a pixel state at position ``(x,y)`` * Set a pixel state at position ``(x,y)``
* @param x TODO * @param x pixel column
* @param y TODO * @param y pixel row
* @param value TODO * @param value pixel state
*/ */
//% help=images/set-pixel //% help=images/set-pixel
//% parts="ledmatrix" //% parts="ledmatrix"
@@ -162,8 +162,8 @@ void setPixel(Image i, int x, int y, bool value) {
/** /**
* Get the pixel state at position ``(x,y)`` * Get the pixel state at position ``(x,y)``
* @param x TODO * @param x pixel column
* @param y TODO * @param y pixel row
*/ */
//% help=images/pixel //% help=images/pixel
//% parts="ledmatrix" //% parts="ledmatrix"
@@ -172,8 +172,8 @@ bool pixel(Image i, int x, int y) {
} }
/** /**
* Shows a particular frame of the image strip. * Show a particular frame of the image strip.
* @param frame TODO * @param frame image frame to show
*/ */
//% weight=70 help=images/show-frame //% weight=70 help=images/show-frame
//% parts="ledmatrix" //% parts="ledmatrix"

6
libs/core/input.cpp
View File

@@ -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) * 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 //% help=input/acceleration weight=58
//% blockId=device_acceleration block="acceleration (mg)|%NAME" blockGap=8 //% 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. * 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 //% help=input/rotation weight=52
//% blockId=device_get_rotation block="rotation (°)|%NAME" blockGap=8 //% 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. * 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 //% help=input/magnetic-force weight=51
//% blockId=device_get_magnetic_force block="magnetic force (µT)|%NAME" blockGap=8 //% blockId=device_get_magnetic_force block="magnetic force (µT)|%NAME" blockGap=8

8
libs/core/led.cpp
View File

@@ -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. * Turn off the specified LED using x, y coordinates (x is horizontal, y is vertical). (0,0) is upper left.
* @param x TODO * @param x the horizontal coordinate of the LED
* @param y TODO * @param y the vertical coordinate of the LED
*/ */
//% help=led/unplot weight=77 //% help=led/unplot weight=77
//% blockId=device_unplot block="unplot|x %x|y %y" blockGap=8 //% 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. * Get the on/off state of the specified LED using x, y coordinates. (0,0) is upper left.
* @param x TODO * @param x the horizontal coordinate of the LED
* @param y TODO * @param y the vertical coordinate of the LED
*/ */
//% help=led/point weight=76 //% help=led/point weight=76
//% blockId=device_point block="point|x %x|y %y" //% blockId=device_point block="point|x %x|y %y"

8
libs/core/led.ts
View File

@@ -55,8 +55,8 @@
/** /**
* Toggles a particular pixel * Toggles a particular pixel
* @param x TODO * @param x pixel column
* @param y TODO * @param y pixel row
*/ */
//% help=led/toggle weight=77 //% help=led/toggle weight=77
//% blockId=device_led_toggle block="toggle|x %x|y %y" icon="\uf204" blockGap=8 //% blockId=device_led_toggle block="toggle|x %x|y %y" icon="\uf204" blockGap=8
@@ -99,7 +99,7 @@
/** /**
* Fades in the screen display. * Fades in the screen display.
* @param ms TODO * @param ms fade time in milleseconds
*/ */
//% help=led/fade-in //% help=led/fade-in
//% parts="ledmatrix" //% parts="ledmatrix"
@@ -122,7 +122,7 @@
/** /**
* Fades out the screen brightness. * Fades out the screen brightness.
* @param ms TODO * @param ms fade time in milliseconds
*/ */
//% help=led/fade-out //% help=led/fade-out
//% parts="ledmatrix" //% parts="ledmatrix"

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

@@ -97,9 +97,9 @@ declare interface Image {
/** /**
* Set a pixel state at position ``(x,y)`` * Set a pixel state at position ``(x,y)``
* @param x TODO * @param x pixel column
* @param y TODO * @param y pixel row
* @param value TODO * @param value pixel state
*/ */
//% help=images/set-pixel //% help=images/set-pixel
//% parts="ledmatrix" shim=ImageMethods::setPixel //% parts="ledmatrix" shim=ImageMethods::setPixel
@@ -107,16 +107,16 @@ declare interface Image {
/** /**
* Get the pixel state at position ``(x,y)`` * Get the pixel state at position ``(x,y)``
* @param x TODO * @param x pixel column
* @param y TODO * @param y pixel row
*/ */
//% help=images/pixel //% help=images/pixel
//% parts="ledmatrix" shim=ImageMethods::pixel //% parts="ledmatrix" shim=ImageMethods::pixel
pixel(x: int32, y: int32): boolean; pixel(x: int32, y: int32): boolean;
/** /**
* Shows a particular frame of the image strip. * Show a particular frame of the image strip.
* @param frame TODO * @param frame image frame to show
*/ */
//% weight=70 help=images/show-frame //% weight=70 help=images/show-frame
//% parts="ledmatrix" interval.defl=400 shim=ImageMethods::showFrame //% 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) * 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 //% help=input/acceleration weight=58
//% blockId=device_acceleration block="acceleration (mg)|%NAME" blockGap=8 //% 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. * 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 //% help=input/rotation weight=52
//% blockId=device_get_rotation block="rotation (°)|%NAME" blockGap=8 //% 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. * 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 //% help=input/magnetic-force weight=51
//% blockId=device_get_magnetic_force block="magnetic force (µT)|%NAME" blockGap=8 //% 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. * Turn off the specified LED using x, y coordinates (x is horizontal, y is vertical). (0,0) is upper left.
* @param x TODO * @param x the horizontal coordinate of the LED
* @param y TODO * @param y the vertical coordinate of the LED
*/ */
//% help=led/unplot weight=77 //% help=led/unplot weight=77
//% blockId=device_unplot block="unplot|x %x|y %y" blockGap=8 //% 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. * Get the on/off state of the specified LED using x, y coordinates. (0,0) is upper left.
* @param x TODO * @param x the horizontal coordinate of the LED
* @param y TODO * @param y the vertical coordinate of the LED
*/ */
//% help=led/point weight=76 //% help=led/point weight=76
//% blockId=device_point block="point|x %x|y %y" //% blockId=device_point block="point|x %x|y %y"