aboutsummaryrefslogtreecommitdiffstats
path: root/src/string
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/string/basename_gnu.c2
-rw-r--r--src/string/mem/memcasecmp.c2
-rw-r--r--src/string/mem/memcasemem.c2
-rw-r--r--src/string/mem/memccpy.c2
-rw-r--r--src/string/mem/memchr.c2
-rw-r--r--src/string/mem/memcmove.c2
-rw-r--r--src/string/mem/memcmp.c2
-rw-r--r--src/string/mem/memcpy.c2
-rw-r--r--src/string/mem/memdup.c2
-rw-r--r--src/string/mem/memmem.c2
-rw-r--r--src/string/mem/memmove.c2
-rw-r--r--src/string/mem/mempcpy.c2
-rw-r--r--src/string/mem/mempmove.c2
-rw-r--r--src/string/mem/memrchr.c2
-rw-r--r--src/string/mem/memset.c2
-rw-r--r--src/string/mem/rawmemchr.c2
-rw-r--r--src/string/memfrob.c2
-rw-r--r--src/string/new.c12
-rw-r--r--src/string/str/rawstrcasestr.c2
-rw-r--r--src/string/str/rawstrstr.c2
-rw-r--r--src/string/str/stpcpy.c2
-rw-r--r--src/string/str/stpmove.c2
-rw-r--r--src/string/str/strcasecmp.c2
-rw-r--r--src/string/str/strcaseends.c2
-rw-r--r--src/string/str/strcasestarts.c2
-rw-r--r--src/string/str/strcasestr.c2
-rw-r--r--src/string/str/strcat.c2
-rw-r--r--src/string/str/strccpy.c2
-rw-r--r--src/string/str/strchr.c2
-rw-r--r--src/string/str/strchrnul.c2
-rw-r--r--src/string/str/strcmove.c2
-rw-r--r--src/string/str/strcmp.c2
-rw-r--r--src/string/str/strcpy.c2
-rw-r--r--src/string/str/strcspn.c2
-rw-r--r--src/string/str/strdup.c2
-rw-r--r--src/string/str/strends.c2
-rw-r--r--src/string/str/strlen.c2
-rw-r--r--src/string/str/strmove.c2
-rw-r--r--src/string/str/strpbrk.c2
-rw-r--r--src/string/str/strrchr.c2
-rw-r--r--src/string/str/strsep.c2
-rw-r--r--src/string/str/strset.c2
-rw-r--r--src/string/str/strspn.c2
-rw-r--r--src/string/str/strstarts.c2
-rw-r--r--src/string/str/strstr.c2
-rw-r--r--src/string/str/strstrcpy.c2
-rw-r--r--src/string/str/strstrmove.c2
-rw-r--r--src/string/str/strtok.c2
-rw-r--r--src/string/str/strtok_r.c2
-rw-r--r--src/string/strerror/strerror.c2
-rw-r--r--src/string/strerror/strerror_l.c2
-rw-r--r--src/string/strerror/strerror_r_gnu.c2
-rw-r--r--src/string/strerror/strerror_r_xsi.c2
-rw-r--r--src/string/strfry.c2
-rw-r--r--src/string/strn/stpncpy.c2
-rw-r--r--src/string/strn/stpnmove.c2
-rw-r--r--src/string/strn/strcncpy.c2
-rw-r--r--src/string/strn/strcnmove.c2
-rw-r--r--src/string/strn/strncasecmp.c2
-rw-r--r--src/string/strn/strncasestr.c2
-rw-r--r--src/string/strn/strncat.c2
-rw-r--r--src/string/strn/strncmp.c2
-rw-r--r--src/string/strn/strncpy.c2
-rw-r--r--src/string/strn/strndup.c2
-rw-r--r--src/string/strn/strnlen.c2
-rw-r--r--src/string/strn/strnmove.c2
-rw-r--r--src/string/strn/strnstr.c2
-rw-r--r--src/string/strn/strstrncpy.c2
-rw-r--r--src/string/strn/strstrnmove.c2
-rw-r--r--src/strings/bcmp.c2
-rw-r--r--src/strings/bcopy.c2
-rw-r--r--src/strings/bzero.c2
-rw-r--r--src/strings/explicit_bzero.c2
-rw-r--r--src/strings/ffs.c2
-rw-r--r--src/strings/ffsl.c2
-rw-r--r--src/strings/ffsll.c2
-rw-r--r--src/strings/index.c2
-rw-r--r--src/strings/rindex.c2
78 files changed, 166 insertions, 0 deletions
diff --git a/src/string/basename_gnu.c b/src/string/basename_gnu.c
index 6fb474a..c25fb1e 100644
--- a/src/string/basename_gnu.c
+++ b/src/string/basename_gnu.c
@@ -34,6 +34,8 @@
* of `filename` or, if `filename` is `NULL`
* or is empty, a statically allocationed string,
* so it must not freed or edited.
+ *
+ * @since Always.
*/
char* __gnu_basename(const char* filename)
{
diff --git a/src/string/mem/memcasecmp.c b/src/string/mem/memcasecmp.c
index d8ea014..816c954 100644
--- a/src/string/mem/memcasecmp.c
+++ b/src/string/mem/memcasecmp.c
@@ -31,6 +31,8 @@
* @param size The size of the segments.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int memcasecmp(const void* a, const void* b, size_t size)
{
diff --git a/src/string/mem/memcasemem.c b/src/string/mem/memcasemem.c
index aad5d68..b15daea 100644
--- a/src/string/mem/memcasemem.c
+++ b/src/string/mem/memcasemem.c
@@ -38,6 +38,8 @@
* @param needle_length The length of `needle`.
* @return Pointer to the first occurrence of
* the substring, `NULL` if not found.
+ *
+ * @since Always.
*/
void* (memcasemem)(const void* __haystack, size_t haystack_length,
const void* __needle, size_t needle_length)
diff --git a/src/string/mem/memccpy.c b/src/string/mem/memccpy.c
index 01b4a4b..f5c669e 100644
--- a/src/string/mem/memccpy.c
+++ b/src/string/mem/memccpy.c
@@ -32,6 +32,8 @@
* that is, the address of `whither` plus the
* number of copied characters; the address of
* one character passed the last written character.
+ *
+ * @since Always.
*/
void* (memccpy)(void* restrict whither, const void* restrict whence, int c, size_t size)
{
diff --git a/src/string/mem/memchr.c b/src/string/mem/memchr.c
index 380fa0f..06c82a8 100644
--- a/src/string/mem/memchr.c
+++ b/src/string/mem/memchr.c
@@ -30,6 +30,8 @@
* @param size The size of the memory segment.
* @return Pointer to the first occurrence of `c`,
* `NULL` if none were found.
+ *
+ * @since Always.
*/
void* (memchr)(const void* segment, int c, size_t size)
{
diff --git a/src/string/mem/memcmove.c b/src/string/mem/memcmove.c
index ad10606..c1cf8ae 100644
--- a/src/string/mem/memcmove.c
+++ b/src/string/mem/memcmove.c
@@ -34,6 +34,8 @@
* that is, the address of `whither` plus the
* number of copied characters; the address of
* one character passed the last written character.
+ *
+ * @since Always.
*/
void* (memcmove)(void* whither, const void* whence, int c, size_t size)
{
diff --git a/src/string/mem/memcmp.c b/src/string/mem/memcmp.c
index 112cdd1..1de506d 100644
--- a/src/string/mem/memcmp.c
+++ b/src/string/mem/memcmp.c
@@ -27,6 +27,8 @@
* @param size The size of the segments.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int memcmp(const void* a, const void* b, size_t size)
{
diff --git a/src/string/mem/memcpy.c b/src/string/mem/memcpy.c
index fcda29d..ccf716b 100644
--- a/src/string/mem/memcpy.c
+++ b/src/string/mem/memcpy.c
@@ -26,6 +26,8 @@
* @param whence The source memory segment.
* @param size The number of bytes to copy.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
void* memcpy(void* restrict whither, const void* restrict whence, size_t size)
{
diff --git a/src/string/mem/memdup.c b/src/string/mem/memdup.c
index 3b301dc..3e3be99 100644
--- a/src/string/mem/memdup.c
+++ b/src/string/mem/memdup.c
@@ -31,6 +31,8 @@
* and `errno` is set to indicate the error.
*
* @throws ENOMEM The process could not allocate sufficient amount of memory.
+ *
+ * @since Always.
*/
void* memdup(const void* segment, size_t size)
{
diff --git a/src/string/mem/memmem.c b/src/string/mem/memmem.c
index 62739d4..71d1f4d 100644
--- a/src/string/mem/memmem.c
+++ b/src/string/mem/memmem.c
@@ -37,6 +37,8 @@
* @param needle_length The length of `needle`.
* @return Pointer to the first occurrence of
* the substring, `NULL` if not found.
+ *
+ * @since Always.
*/
void* (memmem)(const void* __haystack, size_t haystack_length,
const void* __needle, size_t needle_length)
diff --git a/src/string/mem/memmove.c b/src/string/mem/memmove.c
index 41871c6..00ee9c1 100644
--- a/src/string/mem/memmove.c
+++ b/src/string/mem/memmove.c
@@ -26,6 +26,8 @@
* @param whence The source memory segment.
* @param size The number of bytes to copy.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
void* memmove(void* whither, const void* whence, size_t size)
{
diff --git a/src/string/mem/mempcpy.c b/src/string/mem/mempcpy.c
index 2072dc3..97b81f1 100644
--- a/src/string/mem/mempcpy.c
+++ b/src/string/mem/mempcpy.c
@@ -28,6 +28,8 @@
* @param whence The source memory segment.
* @param size The number of bytes to copy.
* @return `whither + size` is returned.
+ *
+ * @since Always.
*/
void* mempcpy(void* restrict whither, const void* restrict whence, size_t size)
{
diff --git a/src/string/mem/mempmove.c b/src/string/mem/mempmove.c
index f837032..415e38b 100644
--- a/src/string/mem/mempmove.c
+++ b/src/string/mem/mempmove.c
@@ -29,6 +29,8 @@
* @param whence The source memory segment.
* @param size The number of bytes to copy.
* @return `whither + size` is returned.
+ *
+ * @since Always.
*/
void* mempmove(void* whither, const void* whence, size_t size)
{
diff --git a/src/string/mem/memrchr.c b/src/string/mem/memrchr.c
index 7325049..2781a71 100644
--- a/src/string/mem/memrchr.c
+++ b/src/string/mem/memrchr.c
@@ -34,6 +34,8 @@
* @param size The size of the memory segment.
* @return Pointer to the last occurrence of `c`,
* `NULL` if none were found.
+ *
+ * @since Always.
*/
void* (memrchr)(const void* segment, int c, size_t size)
{
diff --git a/src/string/mem/memset.c b/src/string/mem/memset.c
index df36052..047620b 100644
--- a/src/string/mem/memset.c
+++ b/src/string/mem/memset.c
@@ -26,6 +26,8 @@
* @param c The character (8 bits wide.)
* @param size The size of the memory segment.
* @return `segment` is returned.
+ *
+ * @since Always.
*/
void* memset(void* segment, int c, size_t size)
{
diff --git a/src/string/mem/rawmemchr.c b/src/string/mem/rawmemchr.c
index 8f5c03e..afaae48 100644
--- a/src/string/mem/rawmemchr.c
+++ b/src/string/mem/rawmemchr.c
@@ -31,6 +31,8 @@
* @param segment The memory segment to search.
* @param c The sought after character.
* @return Pointer to the first occurrence of `c`.
+ *
+ * @since Always.
*/
void* (rawmemchr)(const void* segment, int c)
{
diff --git a/src/string/memfrob.c b/src/string/memfrob.c
index 7ec9abd..77c2e40 100644
--- a/src/string/memfrob.c
+++ b/src/string/memfrob.c
@@ -28,6 +28,8 @@
* @param segment The memory segment.
* @param size The size of the memory segment.
* @return `segment` is returned
+ *
+ * @since Always.
*/
char* memfrob(char* segment, size_t size)
{
diff --git a/src/string/new.c b/src/string/new.c
index 28d2b22..56b4e92 100644
--- a/src/string/new.c
+++ b/src/string/new.c
@@ -28,6 +28,8 @@
* @param str The string.
* @param stop The additional termination-byte.
* @return The number of bytes before, the first termination-byte.
+ *
+ * @since Always.
*/
size_t strclen(const char* string, int stop)
{
@@ -45,6 +47,8 @@ size_t strclen(const char* string, int stop)
* @param maxlen The number of bytes to inspect, at most.
* @return The number of bytes before, the first termination-byte.
* `maxlen` if no termination-byte was found.
+ *
+ * @since Always.
*/
size_t strcnlen(const char* string, int stop, size_t maxlen)
{
@@ -61,6 +65,8 @@ size_t strcnlen(const char* string, int stop, size_t maxlen)
* @param str The string.
* @param stop The additional termination-mark.
* @return The number of bytes before, the first termination-mark.
+ *
+ * @since Always.
*/
size_t strstrlen(const char* string, const char* stop)
{
@@ -79,6 +85,8 @@ size_t strstrlen(const char* string, const char* stop)
* @param maxlen The number of bytes to inspect, at most.
* @return The number of bytes before, the first termination-mark.
* `maxlen` if no termination-byte was found.
+ *
+ * @since Always.
*/
size_t strstrnlen(const char* string, const char* stop, size_t maxlen)
{
@@ -99,6 +107,8 @@ size_t strstrnlen(const char* string, const char* stop, size_t maxlen)
* @param maxlen The number of bytes to inspect, at most.
* @return Pointer to the first occurrence of `c`,
* `NULL` if none were found.
+ *
+ * @since Always.
*/
char* (strnchr)(const char* string, int c, size_t maxlen)
{
@@ -124,6 +134,8 @@ char* (strnchr)(const char* string, int c, size_t maxlen)
* part of the sring) if non were found. If the
* whole string was inspected, the returned
* pointer will point to a NUL byte.
+ *
+ * @since Always.
*/
char* (strnchrnul)(const char* string, int c, size_t maxlen)
{
diff --git a/src/string/str/rawstrcasestr.c b/src/string/str/rawstrcasestr.c
index 7e4cf9b..bae8c38 100644
--- a/src/string/str/rawstrcasestr.c
+++ b/src/string/str/rawstrcasestr.c
@@ -30,6 +30,8 @@
* @param haystack The string to search.
* @param needle The sought after substring.
* @return Pointer to the first occurrence of the substring.
+ *
+ * @since Always.
*/
char* (rawstrcasestr)(const char* haystack, const char* needle)
{
diff --git a/src/string/str/rawstrstr.c b/src/string/str/rawstrstr.c
index 9c3f186..8349210 100644
--- a/src/string/str/rawstrstr.c
+++ b/src/string/str/rawstrstr.c
@@ -29,6 +29,8 @@
* @param haystack The string to search.
* @param needle The sought after substring.
* @return Pointer to the first occurrence of the substring.
+ *
+ * @since Always.
*/
char* (rawstrstr)(const char* haystack, const char* needle)
{
diff --git a/src/string/str/stpcpy.c b/src/string/str/stpcpy.c
index a0d5f79..c643d77 100644
--- a/src/string/str/stpcpy.c
+++ b/src/string/str/stpcpy.c
@@ -26,6 +26,8 @@
* @param whither The destination memory segment.
* @param whence The source memory segment.
* @return `whither + strlen(whence)` is returned.
+ *
+ * @since Always.
*/
char* stpcpy(char* restrict whither, const char* restrict whence)
{
diff --git a/src/string/str/stpmove.c b/src/string/str/stpmove.c
index 8818c30..56ddd24 100644
--- a/src/string/str/stpmove.c
+++ b/src/string/str/stpmove.c
@@ -28,6 +28,8 @@
* @param whither The destination memory segment.
* @param whence The source memory segment.
* @return `whither + strlen(whence)` is returned.
+ *
+ * @since Always.
*/
char* stpmove(char* whither, const char* whence)
{
diff --git a/src/string/str/strcasecmp.c b/src/string/str/strcasecmp.c
index c4b9175..f2d6e83 100644
--- a/src/string/str/strcasecmp.c
+++ b/src/string/str/strcasecmp.c
@@ -31,6 +31,8 @@
* @param b A positive value is returned if this is the lesser.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int strcasecmp(const char* a, const char* b)
{
diff --git a/src/string/str/strcaseends.c b/src/string/str/strcaseends.c
index 9155ea8..b9a1756 100644
--- a/src/string/str/strcaseends.c
+++ b/src/string/str/strcaseends.c
@@ -29,6 +29,8 @@
* @param desired The desired ending of the string.
* @return The `string`, where `desired` beings if
* `string` ends with `desired`, `NULL` otherwise.
+ *
+ * @since Always.
*/
char* (strcaseends)(const char* string, const char* desired)
{
diff --git a/src/string/str/strcasestarts.c b/src/string/str/strcasestarts.c
index f584da4..d17b936 100644
--- a/src/string/str/strcasestarts.c
+++ b/src/string/str/strcasestarts.c
@@ -29,6 +29,8 @@
* @param desired The desired beginning of the string.
* @return `string` if `string` begins with
* `desired`, `NULL` otherwise.
+ *
+ * @since Always.
*/
char* (strcasestarts)(const char* string, const char* desired)
{
diff --git a/src/string/str/strcasestr.c b/src/string/str/strcasestr.c
index 6468750..0ac4368 100644
--- a/src/string/str/strcasestr.c
+++ b/src/string/str/strcasestr.c
@@ -27,6 +27,8 @@
* @param needle The sought after substring.
* @return Pointer to the first occurrence of the
* substring, `NULL` if not found.
+ *
+ * @since Always.
*/
char* (strcasestr)(const char* haystack, const char* needle)
{
diff --git a/src/string/str/strcat.c b/src/string/str/strcat.c
index de5c63e..ec3cbe7 100644
--- a/src/string/str/strcat.c
+++ b/src/string/str/strcat.c
@@ -28,6 +28,8 @@
* @param whither The string to extend.
* @param whence The string to append.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strcat(char* restrict whither, const char* restrict whence)
{
diff --git a/src/string/str/strccpy.c b/src/string/str/strccpy.c
index 2d1bcd8..14b179b 100644
--- a/src/string/str/strccpy.c
+++ b/src/string/str/strccpy.c
@@ -34,6 +34,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strccpy(char* restrict whither, const char* restrict whence, int c)
{
diff --git a/src/string/str/strchr.c b/src/string/str/strchr.c
index 0ed53b4..8226726 100644
--- a/src/string/str/strchr.c
+++ b/src/string/str/strchr.c
@@ -34,6 +34,8 @@
* @param c The sought after character.
* @return Pointer to the first occurrence of `c`,
* `NULL` if none were found.
+ *
+ * @since Always.
*/
char* (strchr)(const char* string, int c)
{
diff --git a/src/string/str/strchrnul.c b/src/string/str/strchrnul.c
index 50dedfe..72ae9bc 100644
--- a/src/string/str/strchrnul.c
+++ b/src/string/str/strchrnul.c
@@ -35,6 +35,8 @@
* @return Pointer to the first occurrence of `c`,
* Pointer to the terminating NUL character
* if none were found.
+ *
+ * @since Always.
*/
char* (strchrnul)(const char* string, int c)
{
diff --git a/src/string/str/strcmove.c b/src/string/str/strcmove.c
index 8310b27..b2f877f 100644
--- a/src/string/str/strcmove.c
+++ b/src/string/str/strcmove.c
@@ -34,6 +34,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strcmove(char* whither, const char* whence, int c)
{
diff --git a/src/string/str/strcmp.c b/src/string/str/strcmp.c
index 3099d71..cf9426d 100644
--- a/src/string/str/strcmp.c
+++ b/src/string/str/strcmp.c
@@ -26,6 +26,8 @@
* @param b A positive value is returned if this is the lesser.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int strcmp(const char* a, const char* b)
{
diff --git a/src/string/str/strcpy.c b/src/string/str/strcpy.c
index 75d88e7..d0fcd76 100644
--- a/src/string/str/strcpy.c
+++ b/src/string/str/strcpy.c
@@ -26,6 +26,8 @@
* @param whither The destination memory segment.
* @param whence The source memory segment.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strcpy(char* restrict whither, const char* restrict whence)
{
diff --git a/src/string/str/strcspn.c b/src/string/str/strcspn.c
index 35b3404..32cb530 100644
--- a/src/string/str/strcspn.c
+++ b/src/string/str/strcspn.c
@@ -27,6 +27,8 @@
* @param string The string.
* @param stopset Bytes disallowed in the substring.
* @return The length of the substring.
+ *
+ * @since Always.
*/
size_t strcspn(const char* string, const char* stopset)
{
diff --git a/src/string/str/strdup.c b/src/string/str/strdup.c
index b7155d7..50ba069 100644
--- a/src/string/str/strdup.c
+++ b/src/string/str/strdup.c
@@ -28,6 +28,8 @@
* and `errno` is set to indicate the error.
*
* @throws ENOMEM The process could not allocate sufficient amount of memory.
+ *
+ * @since Always.
*/
char* strdup(const char* string)
{
diff --git a/src/string/str/strends.c b/src/string/str/strends.c
index 957301c..43dd562 100644
--- a/src/string/str/strends.c
+++ b/src/string/str/strends.c
@@ -29,6 +29,8 @@
* @param desired The desired ending of the string.
* @return The `string`, where `desired` beings if
* `string` ends with `desired`, `NULL` otherwise.
+ *
+ * @since Always.
*/
char* (strends)(const char* string, const char* desired)
{
diff --git a/src/string/str/strlen.c b/src/string/str/strlen.c
index 2092ddc..16b7977 100644
--- a/src/string/str/strlen.c
+++ b/src/string/str/strlen.c
@@ -25,6 +25,8 @@
*
* @param str The string.
* @return The number of bytes before the first NUL byte.
+ *
+ * @since Always.
*/
size_t strlen(const char* str)
{
diff --git a/src/string/str/strmove.c b/src/string/str/strmove.c
index 4bd52f4..892b852 100644
--- a/src/string/str/strmove.c
+++ b/src/string/str/strmove.c
@@ -28,6 +28,8 @@
* @param whither The destination memory segment.
* @param whence The source memory segment.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strmove(char* whither, const char* whence)
{
diff --git a/src/string/str/strpbrk.c b/src/string/str/strpbrk.c
index e479dae..4cfb9ed 100644
--- a/src/string/str/strpbrk.c
+++ b/src/string/str/strpbrk.c
@@ -30,6 +30,8 @@
* @return A pointer to the first occurrence in
* `string` of a byte found in `stopset`.
* `NULL` is returned if none is found.
+ *
+ * @since Always.
*/
char* (strpbrk)(const char* string, const char* stopset)
{
diff --git a/src/string/str/strrchr.c b/src/string/str/strrchr.c
index 716a442..1933765 100644
--- a/src/string/str/strrchr.c
+++ b/src/string/str/strrchr.c
@@ -35,6 +35,8 @@
* @param c The sought after character.
* @return Pointer to the last occurrence of `c`,
* `NULL` if none were found.
+ *
+ * @since Always.
*/
char* (strrchr)(const char* string, int c)
{
diff --git a/src/string/str/strsep.c b/src/string/str/strsep.c
index 9fa0cff..c51e47f 100644
--- a/src/string/str/strsep.c
+++ b/src/string/str/strsep.c
@@ -33,6 +33,8 @@
* `NULL` is returned the search as reached
* the end of the string, and there therefore
* are no more tokens.
+ *
+ * @since Always.
*/
char* strsep(char** restrict string, const char* restrict delimiters)
{
diff --git a/src/string/str/strset.c b/src/string/str/strset.c
index c1eca65..ac1d551 100644
--- a/src/string/str/strset.c
+++ b/src/string/str/strset.c
@@ -28,6 +28,8 @@
* @param str The beginning of the memory segment.
* @param c The character (8 bits wide.)
* @return `str` is returned.
+ *
+ * @since Always.
*/
char* strset(char* str, int c)
{
diff --git a/src/string/str/strspn.c b/src/string/str/strspn.c
index 1b2e034..8a648ff 100644
--- a/src/string/str/strspn.c
+++ b/src/string/str/strspn.c
@@ -27,6 +27,8 @@
* @param string The string.
* @param skipset Bytes allowed in the substring.
* @return The length of the substring.
+ *
+ * @since Always.
*/
size_t strspn(const char* string, const char* skipset)
{
diff --git a/src/string/str/strstarts.c b/src/string/str/strstarts.c
index e132b68..e562f63 100644
--- a/src/string/str/strstarts.c
+++ b/src/string/str/strstarts.c
@@ -29,6 +29,8 @@
* @param desired The desired beginning of the string.
* @return `string` if `string` begins with
* `desired`, `NULL` otherwise.
+ *
+ * @since Always.
*/
char* (strstarts)(const char* string, const char* desired)
{
diff --git a/src/string/str/strstr.c b/src/string/str/strstr.c
index dadbc73..9f88cb4 100644
--- a/src/string/str/strstr.c
+++ b/src/string/str/strstr.c
@@ -27,6 +27,8 @@
* @param needle The sought after substring.
* @return Pointer to the first occurrence of the
* substring, `NULL` if not found.
+ *
+ * @since Always.
*/
char* (strstr)(const char* haystack, const char* needle)
{
diff --git a/src/string/str/strstrcpy.c b/src/string/str/strstrcpy.c
index 9dc9105..bd4c5a6 100644
--- a/src/string/str/strstrcpy.c
+++ b/src/string/str/strstrcpy.c
@@ -34,6 +34,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strstrcpy(char* restrict whither, const char* restrict whence, const char* restrict str)
{
diff --git a/src/string/str/strstrmove.c b/src/string/str/strstrmove.c
index 19969cd..686b0bd 100644
--- a/src/string/str/strstrmove.c
+++ b/src/string/str/strstrmove.c
@@ -34,6 +34,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strstrmove(char* whither, const char* whence, const char* restrict str)
{
diff --git a/src/string/str/strtok.c b/src/string/str/strtok.c
index b1b56b9..a856967 100644
--- a/src/string/str/strtok.c
+++ b/src/string/str/strtok.c
@@ -33,6 +33,8 @@
* `NULL` is returned the search as reached
* the end of the string, and there therefore
* are no more tokens.
+ *
+ * @since Always.
*/
char* strtok(char* restrict string, const char* restrict delimiters)
{
diff --git a/src/string/str/strtok_r.c b/src/string/str/strtok_r.c
index 3005ac7..e29e11b 100644
--- a/src/string/str/strtok_r.c
+++ b/src/string/str/strtok_r.c
@@ -37,6 +37,8 @@
* `NULL` is returned the search as reached
* the end of the string, and there therefore
* are no more tokens.
+ *
+ * @since Always.
*/
char* strtok_r(char* restrict string, const char* restrict delimiters,
char** restrict state)
diff --git a/src/string/strerror/strerror.c b/src/string/strerror/strerror.c
index 315e40d..75af8bd 100644
--- a/src/string/strerror/strerror.c
+++ b/src/string/strerror/strerror.c
@@ -36,6 +36,8 @@
*
* @param errnum The error code.
* @return A description of the error.
+ *
+ * @since Always.
*/
char* strerror(int errnum)
{
diff --git a/src/string/strerror/strerror_l.c b/src/string/strerror/strerror_l.c
index 838040f..0493d9f 100644
--- a/src/string/strerror/strerror_l.c
+++ b/src/string/strerror/strerror_l.c
@@ -34,6 +34,8 @@
* @param locale The locale, must be a valid locale and not
* `LC_GLOBAL_LOCALE`, lest the behaviour is undefined.
* @return A description of the error.
+ *
+ * @since Always.
*/
char* strerror_l(int errnum, locale_t locale)
{
diff --git a/src/string/strerror/strerror_r_gnu.c b/src/string/strerror/strerror_r_gnu.c
index 3e8bfd4..539866a 100644
--- a/src/string/strerror/strerror_r_gnu.c
+++ b/src/string/strerror/strerror_r_gnu.c
@@ -36,6 +36,8 @@
* is set to indicate the error.
*
* @throws ERANGE `buf` was too small to store the description.
+ *
+ * @since Always.
*/
char* __gnu_strerror_r(int errnum, char* buf, size_t buflen)
{
diff --git a/src/string/strerror/strerror_r_xsi.c b/src/string/strerror/strerror_r_xsi.c
index 70c3bc8..028226e 100644
--- a/src/string/strerror/strerror_r_xsi.c
+++ b/src/string/strerror/strerror_r_xsi.c
@@ -35,6 +35,8 @@
* @return Zero on success, value for `errno` on error
*
* @throws ERANGE `buf` was too small to store the description.
+ *
+ * @since Always.
*/
int __xsi_strerror_r(int errnum, char* buf, size_t buflen)
{
diff --git a/src/string/strfry.c b/src/string/strfry.c
index da6d0ac..ac8ef13 100644
--- a/src/string/strfry.c
+++ b/src/string/strfry.c
@@ -30,6 +30,8 @@
*
* @param anagram An anagram of the output, will be modified.
* @retrun The string, which will `== anagram`.
+ *
+ * @since Always.
*/
char* strfry(char* anagram)
{
diff --git a/src/string/strn/stpncpy.c b/src/string/strn/stpncpy.c
index 4290dab..561adc3 100644
--- a/src/string/strn/stpncpy.c
+++ b/src/string/strn/stpncpy.c
@@ -35,6 +35,8 @@
* until this amount of bytes have been written.
* @return `whither` plus the number of written bytes,
* excluding NUL bytes, is returned.
+ *
+ * @since Always.
*/
char* stpncpy(char* restrict whither, const char* restrict whence, size_t maxlen)
{
diff --git a/src/string/strn/stpnmove.c b/src/string/strn/stpnmove.c
index 917b753..e410b49 100644
--- a/src/string/strn/stpnmove.c
+++ b/src/string/strn/stpnmove.c
@@ -36,6 +36,8 @@
* until this amount of bytes have been written.
* @return `whither` plus the number of written bytes,
* excluding NUL bytes, is returned.
+ *
+ * @since Always.
*/
char* stpnmove(char* whither, const char* whence, size_t maxlen)
{
diff --git a/src/string/strn/strcncpy.c b/src/string/strn/strcncpy.c
index 594e7df..fb244b1 100644
--- a/src/string/strn/strcncpy.c
+++ b/src/string/strn/strcncpy.c
@@ -41,6 +41,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strcncpy(char* restrict whither, const char* restrict whence, int c, size_t maxlen)
{
diff --git a/src/string/strn/strcnmove.c b/src/string/strn/strcnmove.c
index 5fbdf19..f039959 100644
--- a/src/string/strn/strcnmove.c
+++ b/src/string/strn/strcnmove.c
@@ -41,6 +41,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strcnmove(char* whither, const char* whence, int c, size_t maxlen)
{
diff --git a/src/string/strn/strncasecmp.c b/src/string/strn/strncasecmp.c
index da9a1ba..d5fa666 100644
--- a/src/string/strn/strncasecmp.c
+++ b/src/string/strn/strncasecmp.c
@@ -32,6 +32,8 @@
* @param length The maximum number of characters to compare.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int strncasecmp(const char* a, const char* b, size_t length)
{
diff --git a/src/string/strn/strncasestr.c b/src/string/strn/strncasestr.c
index e95dc4b..c74d590 100644
--- a/src/string/strn/strncasestr.c
+++ b/src/string/strn/strncasestr.c
@@ -30,6 +30,8 @@
* @param maxlen The maximum number of character to search.
* @return Pointer to the first occurrence of the
* substring, `NULL` if not found.
+ *
+ * @since Always.
*/
char* (strncasestr)(const char* haystack, const char* needle, size_t maxlen)
{
diff --git a/src/string/strn/strncat.c b/src/string/strn/strncat.c
index e7db0f2..1d6d35b 100644
--- a/src/string/strn/strncat.c
+++ b/src/string/strn/strncat.c
@@ -34,6 +34,8 @@
* shorter, `whither` will be filled with NUL bytes
* until this amount of bytes have been written.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strncat(char* restrict whither, const char* restrict whence, size_t maxlen)
{
diff --git a/src/string/strn/strncmp.c b/src/string/strn/strncmp.c
index 2c078d8..08bf5c1 100644
--- a/src/string/strn/strncmp.c
+++ b/src/string/strn/strncmp.c
@@ -27,6 +27,8 @@
* @param length The maximum number of characters to compare.
* @return Zero is returned if `a` and `b` are equal, otherwise,
* see the specifications for `a` and `b`.
+ *
+ * @since Always.
*/
int strncmp(const char* a, const char* b, size_t length)
{
diff --git a/src/string/strn/strncpy.c b/src/string/strn/strncpy.c
index 3a1e66b..199ca9c 100644
--- a/src/string/strn/strncpy.c
+++ b/src/string/strn/strncpy.c
@@ -32,6 +32,8 @@
* shorter, `whither` will be filled with NUL bytes
* until this amount of bytes have been written.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strncpy(char* restrict whither, const char* restrict whence, size_t maxlen)
{
diff --git a/src/string/strn/strndup.c b/src/string/strn/strndup.c
index ca3b3f0..51aa2bb 100644
--- a/src/string/strn/strndup.c
+++ b/src/string/strn/strndup.c
@@ -33,6 +33,8 @@
* and `errno` is set to indicate the error.
*
* @throws ENOMEM The process could not allocate sufficient amount of memory.
+ *
+ * @since Always.
*/
char* strndup(const char* string, size_t maxlen)
{
diff --git a/src/string/strn/strnlen.c b/src/string/strn/strnlen.c
index 5473682..2d45e68 100644
--- a/src/string/strn/strnlen.c
+++ b/src/string/strn/strnlen.c
@@ -27,6 +27,8 @@
* @param maxlen The number of bytes to inspect, at most.
* @return The number of bytes before, the first NUL byte.
* `maxlen` if no NUL byte was found.
+ *
+ * @since Always.
*/
size_t strnlen(const char* str, size_t maxlen)
{
diff --git a/src/string/strn/strnmove.c b/src/string/strn/strnmove.c
index 0d22c15..dc159db 100644
--- a/src/string/strn/strnmove.c
+++ b/src/string/strn/strnmove.c
@@ -34,6 +34,8 @@
* shorter, `whither` will be filled with NUL bytes
* until this amount of bytes have been written.
* @return `whither` is returned.
+ *
+ * @since Always.
*/
char* strnmove(char* whither, const char* whence, size_t maxlen)
{
diff --git a/src/string/strn/strnstr.c b/src/string/strn/strnstr.c
index 8db61ac..e581116 100644
--- a/src/string/strn/strnstr.c
+++ b/src/string/strn/strnstr.c
@@ -31,6 +31,8 @@
* @param maxlen The maximum number of character to search.
* @return Pointer to the first occurrence of the
* substring, `NULL` if not found.
+ *
+ * @since Always.
*/
char* (strnstr)(const char* haystack, const char* needle, size_t maxlen)
{
diff --git a/src/string/strn/strstrncpy.c b/src/string/strn/strstrncpy.c
index 43b58fe..822c4c6 100644
--- a/src/string/strn/strstrncpy.c
+++ b/src/string/strn/strstrncpy.c
@@ -41,6 +41,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strstrncpy(char* restrict whither, const char* restrict whence,
const char* restrict str, size_t maxlen)
diff --git a/src/string/strn/strstrnmove.c b/src/string/strn/strstrnmove.c
index d1c63f9..aadb1a9 100644
--- a/src/string/strn/strstrnmove.c
+++ b/src/string/strn/strstrnmove.c
@@ -41,6 +41,8 @@
* number of copied characters; the address of
* one character passed the last written non-NUL
* character.
+ *
+ * @since Always.
*/
char* strstrnmove(char* whither, const char* whence, const char* restrict str, size_t maxlen)
{
diff --git a/src/strings/bcmp.c b/src/strings/bcmp.c
index 23e6126..73f98be 100644
--- a/src/strings/bcmp.c
+++ b/src/strings/bcmp.c
@@ -24,6 +24,8 @@
* This function is identical to `memcmp`.
*
* @etymology (B)uffer: (c)o(mp)are.
+ *
+ * @since Always.
*/
int bcmp(const void* a, const void* b, size_t size)
{
diff --git a/src/strings/bcopy.c b/src/strings/bcopy.c
index 1abeb7c..fa44e87 100644
--- a/src/strings/bcopy.c
+++ b/src/strings/bcopy.c
@@ -28,6 +28,8 @@
* @param whence The source memory segment.
* @param whither The destination memory segment.
* @param size The number of bytes to copy.
+ *
+ * @since Always.
*/
void bcopy(const void* whence, void* whither, size_t size)
{
diff --git a/src/strings/bzero.c b/src/strings/bzero.c
index e581b94..a85bbda 100644
--- a/src/strings/bzero.c
+++ b/src/strings/bzero.c
@@ -27,6 +27,8 @@
*
* @param segment The memory segment to override.
* @param size The size of the memory segment.
+ *
+ * @since Always.
*/
void bzero(void* segment, size_t size)
{
diff --git a/src/strings/explicit_bzero.c b/src/strings/explicit_bzero.c
index 387c666..34e2cac 100644
--- a/src/strings/explicit_bzero.c
+++ b/src/strings/explicit_bzero.c
@@ -37,6 +37,8 @@ void* (*volatile __slibc_explicit_memset)(void*, int, size_t) = memset;
*
* @param segment The memory segment to override.
* @param size The size of the memory segment.
+ *
+ * @since Always.
*/
void explicit_bzero(void* segment, size_t size)
{
diff --git a/src/strings/ffs.c b/src/strings/ffs.c
index 46ad612..e51c0cf 100644
--- a/src/strings/ffs.c
+++ b/src/strings/ffs.c
@@ -26,6 +26,8 @@
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
+ *
+ * @since Always.
*/
int ffs(int i)
{
diff --git a/src/strings/ffsl.c b/src/strings/ffsl.c
index 3116723..a93387b 100644
--- a/src/strings/ffsl.c
+++ b/src/strings/ffsl.c
@@ -26,6 +26,8 @@
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
+ *
+ * @since Always.
*/
int ffsl(long i)
{
diff --git a/src/strings/ffsll.c b/src/strings/ffsll.c
index 13d4c14..c643b41 100644
--- a/src/strings/ffsll.c
+++ b/src/strings/ffsll.c
@@ -26,6 +26,8 @@
*
* @param i The integer.
* @return The value of the least significant set bit, zero if none.
+ *
+ * @since Always.
*/
int ffsll(long long i)
{
diff --git a/src/strings/index.c b/src/strings/index.c
index 332811d..543fffe 100644
--- a/src/strings/index.c
+++ b/src/strings/index.c
@@ -26,6 +26,8 @@
* This is a deprecated BSD extension.
*
* @etymology (Index) of character.
+ *
+ * @since Always.
*/
char* (index)(const char* string, int c)
{
diff --git a/src/strings/rindex.c b/src/strings/rindex.c
index 3e39a9e..b131367 100644
--- a/src/strings/rindex.c
+++ b/src/strings/rindex.c
@@ -26,6 +26,8 @@
* This is a deprecated BSD extension.
*
* @etymology (R)ight-most (index) of character.
+ *
+ * @since Always.
*/
char* (rindex)(const char* string, int c)
{