diff --git a/docs/Doxyfile b/docs/Doxyfile index fe34d01..a1273d3 100644 --- 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 new file mode 100644 index 0000000..d2783b8 Binary files /dev/null and b/docs/assets/console.png differ diff --git a/docs/assets/image.png b/docs/assets/image.png new file mode 100644 index 0000000..1f626ea Binary files /dev/null and b/docs/assets/image.png differ diff --git a/docs/assets/selector.png b/docs/assets/selector.png new file mode 100644 index 0000000..56c943e Binary files /dev/null and b/docs/assets/selector.png differ diff --git a/include/robodash/views/console.hpp b/include/robodash/views/console.hpp index cdebe66..f2578f2 100644 --- 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 index eaab3fc..c3f973d 100644 --- 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 index 3ed7f8f..242bd51 100644 --- 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. */ /**