add missing documentation about what header to include docs/3.1

Sun, 09 Feb 2025 22:03:52 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 09 Feb 2025 22:03:52 +0100
branch
docs/3.1
changeset 1174
ee473780cc0d
parent 1173
99fc65d2d22b
child 1175
453a45647a32

add missing documentation about what header to include

relates to #451

docs/Writerside/topics/allocator.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/compare.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/mempool.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/test.h.md file | annotate | diff | comparison | revisions
--- a/docs/Writerside/topics/allocator.h.md	Sun Feb 09 22:02:13 2025 +0100
+++ b/docs/Writerside/topics/allocator.h.md	Sun Feb 09 22:03:52 2025 +0100
@@ -12,6 +12,8 @@
 ## Overview
 
 ```C
+#include <cx/allocator.h>
+
 void *cxMalloc(const CxAllocator *allocator, size_t n);
 
 void *cxCalloc(const CxAllocator *allocator,
--- a/docs/Writerside/topics/compare.h.md	Sun Feb 09 22:02:13 2025 +0100
+++ b/docs/Writerside/topics/compare.h.md	Sun Feb 09 22:03:52 2025 +0100
@@ -32,6 +32,8 @@
 ## List of Functions
 
 ```C
+#include <cx/compare.h>
+
 // Value Flavour
 cx_vcmp_double
 cx_vcmp_float
--- a/docs/Writerside/topics/mempool.h.md	Sun Feb 09 22:02:13 2025 +0100
+++ b/docs/Writerside/topics/mempool.h.md	Sun Feb 09 22:03:52 2025 +0100
@@ -13,6 +13,8 @@
 ## Overview
 
 ```C
+#include <cx/mempool.h>
+
 CxMempool *cxMempoolCreate(size_t capacity, cx_destructor_func fnc);
 
 CxMempool *cxMempoolCreateSimple(size_t capacity);
--- a/docs/Writerside/topics/test.h.md	Sun Feb 09 22:02:13 2025 +0100
+++ b/docs/Writerside/topics/test.h.md	Sun Feb 09 22:03:52 2025 +0100
@@ -6,6 +6,8 @@
 An arbitrary number of test cases can be registered with `cx_test_register()`.
 
 ```C
+#include <cx/test.h>
+
 CxTestSuite *suite = cx_test_suite_new("My Suite");
 
 cx_test_register(suite, test_foo);

mercurial