[doc] Add Doxygen Headers to Device Code
Doxygen needs specific `@file` annotations to pick up C headers and
implementation files. This commit adds these annotations, as well as
brief descriptions of each header or implementation file.
Signed-off-by: Sam Elliott <selliott@lowrisc.org>
diff --git a/sw/device/lib/arch/device.h b/sw/device/lib/arch/device.h
index b56a774..61f9586 100644
--- a/sw/device/lib/arch/device.h
+++ b/sw/device/lib/arch/device.h
@@ -8,6 +8,9 @@
#include <stdint.h>
/**
+ * @file
+ * @brief This header contains declarations of device-specific information.
+ *
* This header contains "device-specific" declarations, i.e., information that
* all devices are known to provide, but which is specific to the particular
* choice of platform, which can range from a software simulation, like
diff --git a/sw/device/lib/arch/device_fpga_nexysvideo.c b/sw/device/lib/arch/device_fpga_nexysvideo.c
index f7ee37a..7ea7463 100644
--- a/sw/device/lib/arch/device_fpga_nexysvideo.c
+++ b/sw/device/lib/arch/device_fpga_nexysvideo.c
@@ -5,7 +5,8 @@
#include "sw/device/lib/arch/device.h"
/**
- * Device-specific symbol definitions for the Nexysvideo device.
+ * @file
+ * @brief Device-specific symbol definitions for the Nexysvideo device.
*/
const device_type_t kDeviceType = kDeviceFpgaNexysVideo;
diff --git a/sw/device/lib/arch/device_sim_verilator.c b/sw/device/lib/arch/device_sim_verilator.c
index fa84314..47de216 100644
--- a/sw/device/lib/arch/device_sim_verilator.c
+++ b/sw/device/lib/arch/device_sim_verilator.c
@@ -5,7 +5,8 @@
#include "sw/device/lib/arch/device.h"
/**
- * Device-specific symbol definitions for the Verilator device.
+ * @file
+ * @brief Device-specific symbol definitions for the Verilator device.
*/
const device_type_t kDeviceType = kDeviceSimVerilator;
