From a99f70d8d7d6f771f4450ac8a12dd963bfe5fb08 Mon Sep 17 00:00:00 2001 From: Kimplul Date: Sun, 22 May 2022 23:56:53 +0300 Subject: apply slight doxygen formatting improvements --- include/apos/mem_nodes.h | 2 +- include/apos/types.h | 2 +- include/apos/utils.h | 2 +- include/arch/types.h | 16 ++++++++++++++++ lib/fdt_addresses.c | 2 +- 5 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 include/arch/types.h diff --git a/include/apos/mem_nodes.h b/include/apos/mem_nodes.h index 5a67f08..f0d1361 100644 --- a/include/apos/mem_nodes.h +++ b/include/apos/mem_nodes.h @@ -2,7 +2,7 @@ #define APOS_MM_NODES_H /** - * @file mem_nodes. + * @file mem_nodes.h * Memory node subsystem. Used by the memory region subsystem. */ diff --git a/include/apos/types.h b/include/apos/types.h index 45526d7..97f663b 100644 --- a/include/apos/types.h +++ b/include/apos/types.h @@ -207,6 +207,6 @@ enum { INFO_CONT = 3, /* continue */ }; -#include /* arch-specific type definitions (pm_t/vm_t etc) */ +#include /* arch-specific type definitions (pm_t/vm_t etc) */ #endif /* APOS_TYPES_H */ diff --git a/include/apos/utils.h b/include/apos/utils.h index 25f10b0..126a7ae 100644 --- a/include/apos/utils.h +++ b/include/apos/utils.h @@ -2,7 +2,7 @@ #define APOS_UTILS_H /** - * @file utils. + * @file utils.h * Misc utils and helpers. */ diff --git a/include/arch/types.h b/include/arch/types.h new file mode 100644 index 0000000..d8e93a9 --- /dev/null +++ b/include/arch/types.h @@ -0,0 +1,16 @@ +#ifndef APOS_ARCH_TYPES_H +#define APOS_ARCH_TYPES_H + +/** + * @file types.h + * Arch-specific types. + * + * Doxygen thinks types.h if include/apos/types.h, but it's actually + * arch/whatever/include/types.h. Not sure how to fix that. + * + * \todo Fix incorrect include file reference in doxygen. + */ + +#include + +#endif /* APOS_ARCH_TYPES_H */ diff --git a/lib/fdt_addresses.c b/lib/fdt_addresses.c index 942d3a8..abded6e 100644 --- a/lib/fdt_addresses.c +++ b/lib/fdt_addresses.c @@ -1,6 +1,6 @@ /** * @file - * Wrapper to libfdt fdt_addresses.c, sets up the environment. + * Wrapper to libfdt/fdt_addresses.c, sets up the environment. */ #include "libfdt_env.h" -- cgit v1.3