roland/xo-arena
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

nix-build: xo-arena: build docs + minor doc facepalms

Browse source
This commit is contained in:
Roland Conybeare 2026-02-26 11:47:14 +11:00
commit f7a9eea840
4 changed files with 33 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
CMakeLists.txt
View file

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

26
docs/AllocInfo-reference.rst Normal file
View file

@ -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 | |
+--------------+------------------------+-------------+

2
docs/cmpresult-reference.rst
View file

@ -37,7 +37,7 @@ Class
Constructors
------------
.. doxgyengroup:: mm-cmpresult-ctors
.. doxygengroup:: mm-cmpresult-ctors
Methods
-------

2
include/xo/arena/cmpresult.hpp
View file

@ -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 **/