commit 2b9bb304f9bf7b33a6c07ddffd89afcb336d99bb
author Sam Elliott <selliott@lowrisc.org> Fri Feb 21 14:10:11 2020 +0000
committer Sam Elliott <sam@lenary.co.uk> Wed Jul 08 16:31:53 2020 +0100
tree cf5375acb9a51013f36fe3620ad88e12ab194ec3
parent fdce22fdb33c988fd5199bc34264b5eada786107

[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>

sw/device/lib/arch/device_sim_verilator.c

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;