ELEC2645 (2018/19)
/
el17st
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: mbed FATFileSystem
Revision 6:6f84347e9e14, committed 2019-04-21
- Comitter:
- rottenegg
- Date:
- Sun Apr 21 01:00:37 2019 +0000
- Parent:
- 5:860087ff295e
- Child:
- 7:cbec3402b4e3
- Commit message:
- Documentation Update for CaMove, WDplayer and Bitmap
Changed in this revision
| CaMove/CaMove.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/CaMove/CaMove.h Sun Apr 21 00:41:35 2019 +0000
+++ b/CaMove/CaMove.h Sun Apr 21 01:00:37 2019 +0000
@@ -85,13 +85,12 @@
@endcode
*/
-
#include "mbed.h"
#include "N5110.h"
#include "Bitmap.h"
#include <vector>
-/** Enum for Charater Facing Direction */
+/** Enum For Charater's Facing Direction. */
enum Direction {
Lt, /**< Charater Facing Left. */
Rt, /**< Charater Facing Right. */
@@ -129,7 +128,7 @@
void move(N5110 &lcd);
/** Function to check if charater is in the screen.
*
- *@returns Returns true if charater is on the screen otherwise false.
+ *@return Returns true if charater is on the screen otherwise false.
*
*/
bool in_screen();
@@ -152,7 +151,7 @@
bool is_trg();
/** Function that tells which interactive was triggered.
*
- *@returns Returns an integer based on which region was triggered, regions are labelled according to order of declaration in program counts from 0. Will return -1 if no regions triggered.
+ *@return Returns an integer based on which region was triggered, regions are labelled according to order of declaration in program counts from 0. Will return -1 if no regions triggered.
*
*/
int get_treg();