From f7a9eea8409fba44337be0a809c3ffbc39f46c8e Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Thu, 26 Feb 2026 11:47:14 +1100 Subject: [PATCH] nix-build: xo-arena: build docs + minor doc facepalms --- CMakeLists.txt | 5 +++++ docs/AllocInfo-reference.rst | 26 ++++++++++++++++++++++++++ docs/cmpresult-reference.rst | 2 +- include/xo/arena/cmpresult.hpp | 2 +- 4 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 docs/AllocInfo-reference.rst diff --git a/CMakeLists.txt b/CMakeLists.txt index 36fbfcb..0b6c702 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -28,4 +28,9 @@ add_subdirectory(utest) xo_export_cmake_config(${PROJECT_NAME} ${PROJECT_VERSION} ${PROJECT_NAME}Targets) +# ---------------------------------------------------------------- +# docs targets depend on all the other library/utest targets +# +add_subdirectory(docs) + # end CMakeLists.txt diff --git a/docs/AllocInfo-reference.rst b/docs/AllocInfo-reference.rst new file mode 100644 index 0000000..05da0ea --- /dev/null +++ b/docs/AllocInfo-reference.rst @@ -0,0 +1,26 @@ +.. _AllocInfo-reference: + +AllocInfo Reference +=================== + +Describes a single allocation. +Requires allocator configured to store per-allocation headers + +Context +------- + +.. ditaa:: + :--scale: 0.99 + + +-----------------------------------------------------+ + | DArena | + | DArenaIterator | + +-----------------------------------------------------+ + | ArenaConfig | + +--------------+------------------------+-------------+ + | | AllocInfo cBLU| | + | +------------------------+ | + | AllocError | AllocHeaderConfig | cmpresult | + | +------------------------+ | + | | AllocHeader | | + +--------------+------------------------+-------------+ diff --git a/docs/cmpresult-reference.rst b/docs/cmpresult-reference.rst index 4699854..ecaa4ba 100644 --- a/docs/cmpresult-reference.rst +++ b/docs/cmpresult-reference.rst @@ -37,7 +37,7 @@ Class Constructors ------------ -.. doxgyengroup:: mm-cmpresult-ctors +.. doxygengroup:: mm-cmpresult-ctors Methods ------- diff --git a/include/xo/arena/cmpresult.hpp b/include/xo/arena/cmpresult.hpp index 0a9a911..bf09af5 100644 --- a/include/xo/arena/cmpresult.hpp +++ b/include/xo/arena/cmpresult.hpp @@ -24,7 +24,7 @@ namespace xo { return os; } - /** Result of a generic comparison operation + /** @brief result of a generic comparison operation **/ struct cmpresult { /** @defgroup mm-cmpresult-ctors cmpresult ctors **/