summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoey Castillo <jose.castillo@gmail.com>2021-08-05 16:15:53 -0400
committerJoey Castillo <jose.castillo@gmail.com>2021-08-05 16:15:53 -0400
commit9fca9c718836af89c8c1bbf886562e13011da962 (patch)
treebdc252b9866c7f4867e6f281a7f9ea1edb87715b
parent4e0f249bd23996bc9f3aac6a2bfd5602bdaef53e (diff)
downloadSensor-Watch-9fca9c718836af89c8c1bbf886562e13011da962.tar.gz
Sensor-Watch-9fca9c718836af89c8c1bbf886562e13011da962.tar.bz2
Sensor-Watch-9fca9c718836af89c8c1bbf886562e13011da962.zip
documentation tweaks
-rw-r--r--watch-library/watch/watch.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/watch-library/watch/watch.h b/watch-library/watch/watch.h
index 64fc5355..c842d727 100644
--- a/watch-library/watch/watch.h
+++ b/watch-library/watch/watch.h
@@ -114,24 +114,24 @@ void _watch_init();
void watch_enable_display();
/** @brief Sets a pixel. Use this to manually set a pixel with a given common and segment number.
- * @param com the common pin, numbered from 0-2
- * @param seg the segment pin, numbered from 0-23
+ * @param com the common pin, numbered from 0-2.
+ * @param seg the segment pin, numbered from 0-23.
*/
void watch_set_pixel(uint8_t com, uint8_t seg);
/** @brief Clears a pixel. Use this to manually clear a pixel with a given common and segment number.
- * @param com the common pin, numbered from 0-2
- * @param seg the segment pin, numbered from 0-23
+ * @param com the common pin, numbered from 0-2.
+ * @param seg the segment pin, numbered from 0-23.
* Use this to manually set a pixel with a common and a segment number.
*/
-
void watch_clear_pixel(uint8_t com, uint8_t seg);
/** @brief Displays a string at the given position, starting from the top left. There are ten digits.
A space in any position will clear that digit.
* @param string A null-terminated string.
- * @param position The position to start. The day of week digits are positions 0 and 1, the day of
- month digits are positions 2 and 3, and the main clock line is positions 4-9.
+ * @param position The position where you wish to start displaying the string. The day of week digits
+ * are positions 0 and 1; the day of month digits are positions 2 and 3, and the main
+ * clock line occupies positions 4-9.
* @note This method does not clear the display; if for example you display a two-character string at
position 0, positions 2-9 will retain whatever state they were previously displaying.
*/