Add images, improve docs

unwieldycat · Nov 20, 2023 · a8ab4d8 · a8ab4d8
1 parent 0099753
commit a8ab4d8
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 3 deletions.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -1097,7 +1097,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = ./docs/assets/
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

diff --git a/docs/assets/console.png b/docs/assets/console.png
diff --git a/docs/assets/image.png b/docs/assets/image.png
diff --git a/docs/assets/selector.png b/docs/assets/selector.png
diff --git a/include/robodash/views/console.hpp b/include/robodash/views/console.hpp
@@ -13,6 +13,7 @@ namespace rd {
 /**
  * @defgroup console Console
  * @brief A console for debugging
+ * @image html console.png
  *
  * A GUI console for debugging. Emulates a standard console output.
  */

diff --git a/include/robodash/views/image.hpp b/include/robodash/views/image.hpp
@@ -19,7 +19,11 @@ namespace rd {
  * performance. CF_INDEXED_4_BIT or CF_INDEXED_8_BIT is reccomended for
  * color images.
  *
- * Displays still images.
+ * @image html image.png
+ * @bug The sidebar animations are very choppy when viewing an image. A fix for this will be
+ * implemented for release.
+ *
+ * Displays still images from an SD card or a C array.
  */
 
 /**

diff --git a/include/robodash/views/selector.hpp b/include/robodash/views/selector.hpp
@@ -15,8 +15,10 @@ namespace rd {
 /**
  * @defgroup selector Selector
  * @brief A function selector
+ * @image html selector.png
  *
- * A function selector for autonomous routines. Supports saving a configuration to SD card.
+ * A function selector for easily managing autonomous routines. Supports saving a configuration to
+ * an SD card, and automatically loading it on the next run.
  */
 
 /**