From 9537d8e087731fc6d6de22d29b2dccda572d7f06 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 25 Nov 2015 11:46:10 +0100 Subject: tell in doc in which version things were introduced MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/string/str/rawstrcasestr.c | 2 ++ src/string/str/rawstrstr.c | 2 ++ src/string/str/stpcpy.c | 2 ++ src/string/str/stpmove.c | 2 ++ src/string/str/strcasecmp.c | 2 ++ src/string/str/strcaseends.c | 2 ++ src/string/str/strcasestarts.c | 2 ++ src/string/str/strcasestr.c | 2 ++ src/string/str/strcat.c | 2 ++ src/string/str/strccpy.c | 2 ++ src/string/str/strchr.c | 2 ++ src/string/str/strchrnul.c | 2 ++ src/string/str/strcmove.c | 2 ++ src/string/str/strcmp.c | 2 ++ src/string/str/strcpy.c | 2 ++ src/string/str/strcspn.c | 2 ++ src/string/str/strdup.c | 2 ++ src/string/str/strends.c | 2 ++ src/string/str/strlen.c | 2 ++ src/string/str/strmove.c | 2 ++ src/string/str/strpbrk.c | 2 ++ src/string/str/strrchr.c | 2 ++ src/string/str/strsep.c | 2 ++ src/string/str/strset.c | 2 ++ src/string/str/strspn.c | 2 ++ src/string/str/strstarts.c | 2 ++ src/string/str/strstr.c | 2 ++ src/string/str/strstrcpy.c | 2 ++ src/string/str/strstrmove.c | 2 ++ src/string/str/strtok.c | 2 ++ src/string/str/strtok_r.c | 2 ++ 31 files changed, 62 insertions(+) (limited to 'src/string/str') 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) -- cgit v1.2.3-70-g09d2