microbit-dal: minor spelling corrections
Courtesy of @gbaman
This commit is contained in:
parent
c028238147
commit
862528bb93
|
@ -148,7 +148,7 @@ class MicroBitMultiButton : public MicroBitComponent
|
|||
|
||||
/**
|
||||
* Changes the event configuration of this button to the given MicroBitButtonEventConfiguration.
|
||||
* All subsequent events generated by this button will then be informed by this configuraiton.
|
||||
* All subsequent events generated by this button will then be informed by this configuration.
|
||||
*
|
||||
* @param config The new configuration for this button. Legal values are MICROBIT_BUTTON_ALL_EVENTS or MICROBIT_BUTTON_SIMPLE_EVENTS.
|
||||
*
|
||||
|
|
|
@ -208,7 +208,7 @@ class MicroBitRadio : MicroBitComponent
|
|||
*
|
||||
* @return The buffer containing the the packet. If no data is available, NULL is returned.
|
||||
*
|
||||
* @note Once recv() has been called, it is the callers resposibility to
|
||||
* @note Once recv() has been called, it is the callers responsibility to
|
||||
* delete the buffer when appropriate.
|
||||
*/
|
||||
FrameBuffer* recv();
|
||||
|
|
|
@ -199,7 +199,7 @@ class ManagedString
|
|||
*
|
||||
* Called when one ManagedString is assigned the value of another.
|
||||
*
|
||||
* If the ManagedString being assigned is already refering to a character buffer,
|
||||
* If the ManagedString being assigned is already referring to a character buffer,
|
||||
* decrement the reference count and free up the buffer as necessary.
|
||||
*
|
||||
* Then, update our character buffer to refer to that of the supplied ManagedString,
|
||||
|
|
|
@ -247,7 +247,7 @@ class MicroBitImage
|
|||
int setPixelValue(int16_t x , int16_t y, uint8_t value);
|
||||
|
||||
/**
|
||||
* Retreives the value of a given pixel.
|
||||
* Retrieves the value of a given pixel.
|
||||
*
|
||||
* @param x The x co-ordinate of the pixel to read. Must be within the dimensions of the image.
|
||||
*
|
||||
|
@ -287,7 +287,7 @@ class MicroBitImage
|
|||
/**
|
||||
* Pastes a given bitmap at the given co-ordinates.
|
||||
*
|
||||
* Any pixels in the relvant area of this image are replaced.
|
||||
* Any pixels in the relevant area of this image are replaced.
|
||||
*
|
||||
* @param image The MicroBitImage to paste.
|
||||
*
|
||||
|
|
|
@ -208,7 +208,7 @@ void MicroBitMultiButton::setSupressedState(uint16_t button, int value)
|
|||
|
||||
/**
|
||||
* Changes the event configuration of this button to the given MicroBitButtonEventConfiguration.
|
||||
* All subsequent events generated by this button will then be informed by this configuraiton.
|
||||
* All subsequent events generated by this button will then be informed by this configuration.
|
||||
*
|
||||
* @param config The new configuration for this button. Legal values are MICROBIT_BUTTON_ALL_EVENTS or MICROBIT_BUTTON_SIMPLE_EVENTS.
|
||||
*
|
||||
|
|
|
@ -443,7 +443,7 @@ int MicroBitRadio::dataReady()
|
|||
*
|
||||
* @return The buffer containing the the packet. If no data is available, NULL is returned.
|
||||
*
|
||||
* @note Once recv() has been called, it is the callers resposibility to
|
||||
* @note Once recv() has been called, it is the callers responsibility to
|
||||
* delete the buffer when appropriate.
|
||||
*/
|
||||
FrameBuffer* MicroBitRadio::recv()
|
||||
|
|
|
@ -306,7 +306,7 @@ ManagedString::~ManagedString()
|
|||
*
|
||||
* Called when one ManagedString is assigned the value of another.
|
||||
*
|
||||
* If the ManagedString being assigned is already refering to a character buffer,
|
||||
* If the ManagedString being assigned is already referring to a character buffer,
|
||||
* decrement the reference count and free up the buffer as necessary.
|
||||
*
|
||||
* Then, update our character buffer to refer to that of the supplied ManagedString,
|
||||
|
@ -471,7 +471,7 @@ ManagedString operator+ (const ManagedString& lhs, const ManagedString& rhs)
|
|||
*
|
||||
* @param index The position of the character to return.
|
||||
*
|
||||
* @return the character at posisiton index, zero if index is invalid.
|
||||
* @return the character at position index, zero if index is invalid.
|
||||
*
|
||||
* @code
|
||||
* MicroBitDisplay display;
|
||||
|
|
|
@ -396,7 +396,7 @@ int MicroBitImage::setPixelValue(int16_t x , int16_t y, uint8_t value)
|
|||
}
|
||||
|
||||
/**
|
||||
* Retreives the value of a given pixel.
|
||||
* Retrieves the value of a given pixel.
|
||||
*
|
||||
* @param x The x co-ordinate of the pixel to read. Must be within the dimensions of the image.
|
||||
*
|
||||
|
@ -469,7 +469,7 @@ int MicroBitImage::printImage(int16_t width, int16_t height, const uint8_t *bitm
|
|||
/**
|
||||
* Pastes a given bitmap at the given co-ordinates.
|
||||
*
|
||||
* Any pixels in the relvant area of this image are replaced.
|
||||
* Any pixels in the relevant area of this image are replaced.
|
||||
*
|
||||
* @param image The MicroBitImage to paste.
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue