From 1c8f439f7ad307b0b32a989194275bc40f71c640 Mon Sep 17 00:00:00 2001 From: Marian Buschsieweke Date: Wed, 4 Jan 2023 12:21:39 +0100 Subject: [PATCH] boards/hamilton: Add minimal doc The doc of the board is still suboptimal, but at least an image to identify what board this is and a link to further information is a starting point. --- boards/hamilton/doc.txt | 10 ++++++++++ boards/hamilton/include/board.h | 3 +-- 2 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 boards/hamilton/doc.txt diff --git a/boards/hamilton/doc.txt b/boards/hamilton/doc.txt new file mode 100644 index 0000000000..a9060c8ed5 --- /dev/null +++ b/boards/hamilton/doc.txt @@ -0,0 +1,10 @@ +/** +@defgroup boards_hamilton HamiltonIoT Hamilton +@ingroup boards +@brief Support for the HamiltonIoT Hamilton board. + +@image html "https://github.com/immesys/baseliner/raw/fa1f224b0a6eaf101dfeb2abe3127ecc5acd0986/misc/hamilton-sm.jpg" "Image of the Hamilton IoT board next to coin" width=80% + +See https://github.com/hamilton-mote/hw for more details on the hardware. + + */ diff --git a/boards/hamilton/include/board.h b/boards/hamilton/include/board.h index 90a980e3dc..51241d3a06 100644 --- a/boards/hamilton/include/board.h +++ b/boards/hamilton/include/board.h @@ -7,8 +7,7 @@ */ /** - * @defgroup boards_hamilton HamiltonIoT Hamilton - * @ingroup boards + * @ingroup boards_hamilton * @brief Support for the HamiltonIoT Hamilton board. * @{ *