Welcome to little lamb

Code » limb » commit 33effc4

Various fixes in stralloc documentation

author Olivier Brunel
2023-06-07 11:26:33 UTC
committer Olivier Brunel
2023-07-05 07:39:26 UTC
parent 424113b8f4d27350490e0ab42ca0c21c19bb3bff

Various fixes in stralloc documentation

src/doc/stralloc.h.0.md +1 -3
src/doc/stralloc.h/stralloc_cat.3.md +22 -22
src/doc/stralloc.h/stralloc_ready_tuned.3.md +6 -2
src/doc/stralloc.h/stralloc_remove.3.md +3 -3
src/doc/stralloc.h/stralloc_reverse.3.md +1 -1

diff --git a/src/doc/stralloc.h.0.md b/src/doc/stralloc.h.0.md
index 8a729b6..9165e94 100644
--- a/src/doc/stralloc.h.0.md
+++ b/src/doc/stralloc.h.0.md
@@ -13,9 +13,7 @@ stralloc.h - heap memory management
 
 This header defines functions to work heap-allocated memory.
 
-! INFO: skalibs
-! This header is a complement to skalibs' own [skalibs/stralloc.h](0) and thusly
-! includes said header. The documentation below applies to that combination.
+<inc skalibs.md>
 
 ## Structures
 
diff --git a/src/doc/stralloc.h/stralloc_cat.3.md b/src/doc/stralloc.h/stralloc_cat.3.md
index 2643895..5a44fd3 100644
--- a/src/doc/stralloc.h/stralloc_cat.3.md
+++ b/src/doc/stralloc.h/stralloc_cat.3.md
@@ -3,34 +3,34 @@
 
 # NAME
 
-stralloc\_catb, stralloc\_cats, stralloc\_cats0, stralloc_catv, stralloc\_cat,
-stralloc\_copyb, stralloc\_copys, stralloc\_copys0, stralloc\_copy,
-stralloc\insertb, stralloc\_inserts, stralloc\_inserts0, stralloc\_insert,
-stralloc\\append, stralloc_0 - adding data into a stralloc
+stralloc_catb, stralloc_cats, stralloc_cats0, stralloc_catv, stralloc_cat,
+stralloc_copyb, stralloc_copys, stralloc_copys0, stralloc_copy,
+stralloc_insertb, stralloc_inserts, stralloc_inserts0, stralloc_insert,
+stralloc_append, stralloc_0 - adding data into a stralloc
 
 # SYNOPSIS
 
     #include <limb/stralloc.h>
 
 ```pre hl
-int stralloc_catb(stralloc *sa, const char *data, size_t dlen)
-int stralloc_cats(stralloc *sa, const char *str)
-int stralloc_cats0(stralloc *sa, const char *str)
-int stralloc_catv(stralloc *sa, const struct iovec *v, unsigned n)
-int stralloc_cat(stralloc *sa, const stralloc *sasce)
-
-int stralloc_copyb(stralloc *sa, const char *data, size_t dlen)
-int stralloc_copys(stralloc *sa, const char *str)
-int stralloc_copys0(stralloc *sa, const char *str)
-int stralloc_copy(stralloc *sa1, const stralloc *sasce)
-
-int stralloc_insertb(stralloc *sa, size_t offset, const char *data, size_t dlen)
-int stralloc_inserts(stralloc *sa, size_t offset, const char *str)
-int stralloc_inserts0(stralloc *sa, size_t offset, const char *str)
-int stralloc_insert(stralloc *sa, size_t offset, const stralloc *sasce)
-
-int stralloc_append(stralloc *sa, char c)
-int stralloc_0(stralloc *sa)
+int stralloc_catb(stralloc *<em>sa</em>, const char *<em>data</em>, size_t <em>dlen</em>)
+int stralloc_cats(stralloc *<em>sa</em>, const char *<em>str</em>)
+int stralloc_cats0(stralloc *<em>sa</em>, const char *<em>str</em>)
+int stralloc_catv(stralloc *<em>sa</em>, const struct iovec *<em>v</em>, unsigned <em>n</em>)
+int stralloc_cat(stralloc *<em>sa</em>, const stralloc *<em>sasce</em>)
+
+int stralloc_copyb(stralloc *<em>sa</em>, const char *<em>data</em>, size_t <em>dlen</em>)
+int stralloc_copys(stralloc *<em>sa</em>, const char *<em>str</em>)
+int stralloc_copys0(stralloc *<em>sa</em>, const char *<em>str</em>)
+int stralloc_copy(stralloc *<em>sa</em>, const stralloc *<em>sasce</em>)
+
+int stralloc_insertb(stralloc *<em>sa</em>, size_t <em>offset</em>, const char *<em>data</em>, size_t <em>dlen</em>)
+int stralloc_inserts(stralloc *<em>sa</em>, size_t <em>offset</em>, const char *<em>str</em>)
+int stralloc_inserts0(stralloc *<em>sa</em>, size_t <em>offset</em>, const char *<em>str</em>)
+int stralloc_insert(stralloc *<em>sa</em>, size_t <em>offset</em>, const stralloc *<em>sasce</em>)
+
+int stralloc_append(stralloc *<em>sa</em>, char <em>c</em>)
+int stralloc_0(stralloc *<em>sa</em>)
 ```
 
 # DESCRIPTION
diff --git a/src/doc/stralloc.h/stralloc_ready_tuned.3.md b/src/doc/stralloc.h/stralloc_ready_tuned.3.md
index 03bd20d..1a8e643 100644
--- a/src/doc/stralloc.h/stralloc_ready_tuned.3.md
+++ b/src/doc/stralloc.h/stralloc_ready_tuned.3.md
@@ -3,8 +3,8 @@
 
 # NAME
 
-stralloc\_ready\_tuned, stralloc\_readyplus\_tuned, stralloc\_ready,
-stralloc\_readyplus, stralloc\_free, stralloc\_shrink - allocate and free memory
+stralloc_ready_tuned, stralloc_readyplus_tuned, stralloc_ready,
+stralloc_readyplus, stralloc_free, stralloc_shrink - allocate and free memory
 associated with a stralloc
 
 # SYNOPSIS
@@ -68,3 +68,7 @@ and `stralloc_readyplus`() functions may also fail if :
 
 : *ERANGE*
 :: Overflow.
+
+# SEE ALSO
+
+[stralloc_remove](3)
diff --git a/src/doc/stralloc.h/stralloc_remove.3.md b/src/doc/stralloc.h/stralloc_remove.3.md
index db3c522..f7064e8 100644
--- a/src/doc/stralloc.h/stralloc_remove.3.md
+++ b/src/doc/stralloc.h/stralloc_remove.3.md
@@ -3,7 +3,7 @@
 
 # NAME
 
-stralloc\_remove - remove data from a stralloc
+stralloc_remove - remove data from a stralloc
 
 # SYNOPSIS
 
@@ -23,8 +23,8 @@ re-allocation occurs.
 
 # RETURN VALUE
 
-The `stralloc_remove`() function return 1 on success. Otherwise they return 0
-and set `errno` to indicate the error.
+The `stralloc_remove`() function returns 1 on success. Otherwise it returns 0
+and sets `errno` to indicate the error.
 
 # ERRORS
 
diff --git a/src/doc/stralloc.h/stralloc_reverse.3.md b/src/doc/stralloc.h/stralloc_reverse.3.md
index 4bf7a74..e2f4bff 100644
--- a/src/doc/stralloc.h/stralloc_reverse.3.md
+++ b/src/doc/stralloc.h/stralloc_reverse.3.md
@@ -3,7 +3,7 @@
 
 # NAME
 
-stralloc\_reverse, stralloc\_reverse\_blocks - reverse the content of a stralloc
+stralloc_reverse, stralloc_reverse_blocks - reverse the content of a stralloc
 
 # SYNOPSIS