]> git.earman.xyz Git - sensor-watch.git/commitdiff
documentation tweaks
authorJoey Castillo <jose.castillo@gmail.com>
Thu, 5 Aug 2021 20:15:53 +0000 (16:15 -0400)
committerJoey Castillo <jose.castillo@gmail.com>
Thu, 5 Aug 2021 20:15:53 +0000 (16:15 -0400)
watch-library/watch/watch.h

index 64fc5355e4621b8758fa9e9cb91b941b1cc91a1b..c842d727a04e56776eb2ca468add8a87789e5050 100644 (file)
@@ -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.
   */