]> git.earman.xyz Git - sensor-watch.git/commitdiff
add segment map link
authorJoey Castillo <jose.castillo@gmail.com>
Sat, 7 Aug 2021 17:48:01 +0000 (13:48 -0400)
committerJoey Castillo <jose.castillo@gmail.com>
Sat, 7 Aug 2021 17:48:01 +0000 (13:48 -0400)
watch-library/watch/watch.h

index 6711353c7f39a48ce12c420384b0004f60bccd86..8cb949f62a7a9a6f8bae8fd0c6a5631f6c7adc16 100644 (file)
@@ -106,6 +106,9 @@ void _watch_init();
 /** @addtogroup slcd Segment LCD Display
   * @brief This section covers functions related to the Segment LCD display driver, which is responsible
   *        for displaying strings of characters and indicators on the main watch display.
+  * @details For a map of all common and segment pins, see <a href="segmap.html">segmap.html</a>. You can 
+  *          hover over any segment in that diagram to view the common and segment pins associated with
+  *          each segment of the display.
   */
 /// @{
 
@@ -123,12 +126,14 @@ typedef enum WatchIndicatorSegment {
 void watch_enable_display();
 
 /** @brief Sets a pixel. Use this to manually set a pixel with a given common and segment number.
+  *        See <a href="segmap.html">segmap.html</a>.
   * @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.
+  *        See <a href="segmap.html">segmap.html</a>.
   * @param com the common pin, numbered from 0-2.
   * @param seg the segment pin, numbered from 0-23.
   */