[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/base/freestanding/float.h b/sw/device/lib/base/freestanding/float.h
index 0cf3b9c..6a7e010 100644
--- a/sw/device/lib/base/freestanding/float.h
+++ b/sw/device/lib/base/freestanding/float.h
@@ -6,6 +6,9 @@
#define OPENTITAN_SW_DEVICE_LIB_BASE_FREESTANDING_FLOAT_H_
/**
+ * @file
+ * @brief C library Floating-point environment (Freestanding)
+ *
* This header implements the float.h standard header, as required by C11 S4p6.
* This header is specified in detail in S7.7 and S5.2.4.2.2 of the same.
*
@@ -13,58 +16,58 @@
* https://clang.llvm.org/doxygen/float_8h_source.html
*/
-#define FLT_EVAL_METHOD __FLT_EVAL_METHOD__
-#define FLT_ROUNDS (-1)
-#define FLT_RADIX __FLT_RADIX__
+#define FLT_EVAL_METHOD __FLT_EVAL_METHOD__ /**< @hideinitializer */
+#define FLT_ROUNDS (-1) /**< @hideinitializer */
+#define FLT_RADIX __FLT_RADIX__ /**< @hideinitializer */
-#define FLT_MANT_DIG __FLT_MANT_DIG__
-#define DBL_MANT_DIG __DBL_MANT_DIG__
-#define LDBL_MANT_DIG __LDBL_MANT_DIG__
+#define FLT_MANT_DIG __FLT_MANT_DIG__ /**< @hideinitializer */
+#define DBL_MANT_DIG __DBL_MANT_DIG__ /**< @hideinitializer */
+#define LDBL_MANT_DIG __LDBL_MANT_DIG__ /**< @hideinitializer */
-#define DECIMAL_DIG __DECIMAL_DIG__
+#define DECIMAL_DIG __DECIMAL_DIG__ /**< @hideinitializer */
-#define FLT_DIG __FLT_DIG__
-#define DBL_DIG __DBL_DIG__
-#define LDBL_DIG __LDBL_DIG__
+#define FLT_DIG __FLT_DIG__ /**< @hideinitializer */
+#define DBL_DIG __DBL_DIG__ /**< @hideinitializer */
+#define LDBL_DIG __LDBL_DIG__ /**< @hideinitializer */
-#define FLT_MIN_EXP __FLT_MIN_EXP__
-#define DBL_MIN_EXP __DBL_MIN_EXP__
-#define LDBL_MIN_EXP __LDBL_MIN_EXP__
+#define FLT_MIN_EXP __FLT_MIN_EXP__ /**< @hideinitializer */
+#define DBL_MIN_EXP __DBL_MIN_EXP__ /**< @hideinitializer */
+#define LDBL_MIN_EXP __LDBL_MIN_EXP__ /**< @hideinitializer */
-#define FLT_MIN_10_EXP __FLT_MIN_10_EXP__
-#define DBL_MIN_10_EXP __DBL_MIN_10_EXP__
-#define LDBL_MIN_10_EXP __LDBL_MIN_10_EXP__
+#define FLT_MIN_10_EXP __FLT_MIN_10_EXP__ /**< @hideinitializer */
+#define DBL_MIN_10_EXP __DBL_MIN_10_EXP__ /**< @hideinitializer */
+#define LDBL_MIN_10_EXP __LDBL_MIN_10_EXP__ /**< @hideinitializer */
-#define FLT_MAX_EXP __FLT_MAX_EXP__
-#define DBL_MAX_EXP __DBL_MAX_EXP__
-#define LDBL_MAX_EXP __LDBL_MAX_EXP__
+#define FLT_MAX_EXP __FLT_MAX_EXP__ /**< @hideinitializer */
+#define DBL_MAX_EXP __DBL_MAX_EXP__ /**< @hideinitializer */
+#define LDBL_MAX_EXP __LDBL_MAX_EXP__ /**< @hideinitializer */
-#define FLT_MAX_10_EXP __FLT_MAX_10_EXP__
-#define DBL_MAX_10_EXP __DBL_MAX_10_EXP__
-#define LDBL_MAX_10_EXP __LDBL_MAX_10_EXP__
+#define FLT_MAX_10_EXP __FLT_MAX_10_EXP__ /**< @hideinitializer */
+#define DBL_MAX_10_EXP __DBL_MAX_10_EXP__ /**< @hideinitializer */
+#define LDBL_MAX_10_EXP __LDBL_MAX_10_EXP__ /**< @hideinitializer */
-#define FLT_MAX __FLT_MAX__
-#define DBL_MAX __DBL_MAX__
-#define LDBL_MAX __LDBL_MAX__
+#define FLT_MAX __FLT_MAX__ /**< @hideinitializer */
+#define DBL_MAX __DBL_MAX__ /**< @hideinitializer */
+#define LDBL_MAX __LDBL_MAX__ /**< @hideinitializer */
-#define FLT_EPSILON __FLT_EPSILON__
-#define DBL_EPSILON __DBL_EPSILON__
-#define LDBL_EPSILON __LDBL_EPSILON__
+#define FLT_EPSILON __FLT_EPSILON__ /**< @hideinitializer */
+#define DBL_EPSILON __DBL_EPSILON__ /**< @hideinitializer */
+#define LDBL_EPSILON __LDBL_EPSILON__ /**< @hideinitializer */
-#define FLT_MIN __FLT_MIN__
-#define DBL_MIN __DBL_MIN__
-#define LDBL_MIN __LDBL_MIN__
+#define FLT_MIN __FLT_MIN__ /**< @hideinitializer */
+#define DBL_MIN __DBL_MIN__ /**< @hideinitializer */
+#define LDBL_MIN __LDBL_MIN__ /**< @hideinitializer */
-#define FLT_TRUE_MIN __FLT_DENORM_MIN__
-#define DBL_TRUE_MIN __DBL_DENORM_MIN__
-#define LDBL_TRUE_MIN __LDBL_DENORM_MIN__
+#define FLT_TRUE_MIN __FLT_DENORM_MIN__ /**< @hideinitializer */
+#define DBL_TRUE_MIN __DBL_DENORM_MIN__ /**< @hideinitializer */
+#define LDBL_TRUE_MIN __LDBL_DENORM_MIN__ /**< @hideinitializer */
-#define FLT_DECIMAL_DIG __FLT_DECIMAL_DIG__
-#define DBL_DECIMAL_DIG __DBL_DECIMAL_DIG__
-#define LDBL_DECIMAL_DIG __LDBL_DECIMAL_DIG__
+#define FLT_DECIMAL_DIG __FLT_DECIMAL_DIG__ /**< @hideinitializer */
+#define DBL_DECIMAL_DIG __DBL_DECIMAL_DIG__ /**< @hideinitializer */
+#define LDBL_DECIMAL_DIG __LDBL_DECIMAL_DIG__ /**< @hideinitializer */
-#define FLT_HAS_SUBNORM __FLT_HAS_DENORM__
-#define DBL_HAS_SUBNORM __DBL_HAS_DENORM__
-#define LDBL_HAS_SUBNORM __LDBL_HAS_DENORM__
+#define FLT_HAS_SUBNORM __FLT_HAS_DENORM__ /**< @hideinitializer */
+#define DBL_HAS_SUBNORM __DBL_HAS_DENORM__ /**< @hideinitializer */
+#define LDBL_HAS_SUBNORM __LDBL_HAS_DENORM__ /**< @hideinitializer */
#endif // OPENTITAN_SW_DEVICE_LIB_BASE_FREESTANDING_FLOAT_H_
