aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles <sircharlesaze@gmail.com>2020-02-13 05:15:32 +0100
committerCharles <sircharlesaze@gmail.com>2020-02-13 05:15:32 +0100
commit2d1fcee4db6a9411b6f7db2c36791f67472109dc (patch)
treebe37464fcda6dba615a2c232c5ea67fe29e1a4f6
parenta23c6f76ddd6d6ba4d5163ebbbcf290202a1b36a (diff)
downloadlibft-2d1fcee4db6a9411b6f7db2c36791f67472109dc.tar.gz
libft-2d1fcee4db6a9411b6f7db2c36791f67472109dc.tar.bz2
libft-2d1fcee4db6a9411b6f7db2c36791f67472109dc.zip
Added mem and ctype documentation
-rw-r--r--README.md51
1 files changed, 25 insertions, 26 deletions
diff --git a/README.md b/README.md
index 5731564..0d6b8cd 100644
--- a/README.md
+++ b/README.md
@@ -34,19 +34,19 @@ Much like the `.gitignore` file, you can put the files/directory to ignore when
-| Name | prototype | description | tested |
-|------|-----------|-------------|--------|
-| ft_bzero | `void ft_bzero(void *s, size_t n)` | fill `n` bytes of `s` with 0 | [x] |
-| ft_calloc | `void *ft_calloc(size_t count, size_t size)` | allocate `count` element of `size` and initialize them to 0 | [ ] |
-| ft_memccpy | `void *ft_memccpy(void *dest, const void *src, int c, size_t n)` | copy `n` byte from `src` to `dest` until `c` is reached | [ ] |
-| ft_memchr | `void *ft_memchr(const void *s, int c, size_t n)` | return the address of the first occurance of `c` in `s` or NULL if `c` isn't found | [ ] |
-| ft_memcmp | `int ft_memcmp(const void *s1, const void *s2, size_t n)` | compare `n` byte of `s1` and `s2` | [ ] |
-| ft_memcpy | `void *ft_memcpy(void *dest, const void *src, size_t n)` | copy `n` byte from `src` to `dest` | [x] |
-| ft_memmem | `void *ft_memmem(const void *big, size_t big_len, const void *little, size_t little_len)` | search `little` in `big` | [ ] |
-| ft_memmove | `void *ft_memmove(void *dst, const void *src, size_t len)` | copy `len` byte from `src` to `dst` and the copied memory can overlap | [ ] |
-| ft_memset | `void *ft_memset(void *s, int c, size_t n)` | set `n` byte of `s` to `c` | [x] |
-| ft_memset_pattern4 | `void ft_memset_pattern4(void *b, const void *pattern4, size_t len)` | set `len` byte of `b` to a reapeated pattern of 4 bytes | [ ] |
-| ft_memswap | `void ft_memswap(void *a, void *b, size_t size)` | swap `a` and `b` memory | [x] |
+| Name | Prototype | Description | Tested |
+|--------------------|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|--------|
+| ft_bzero | `void ft_bzero(void *s, size_t n)` | fill `n` bytes of `s` with 0 | [x] |
+| ft_calloc | `void *ft_calloc(size_t count, size_t size)` | allocate `count` element of `size` and initialize them to 0 | [ ] |
+| ft_memccpy | `void *ft_memccpy(void *dest, const void *src, int c, size_t n)` | copy `n` byte from `src` to `dest` until `c` is reached | [ ] |
+| ft_memchr | `void *ft_memchr(const void *s, int c, size_t n)` | return the address of the first occurance of `c` in `s` or NULL if `c` isn't found | [ ] |
+| ft_memcmp | `int ft_memcmp(const void *s1, const void *s2, size_t n)` | compare `n` byte of `s1` and `s2` | [ ] |
+| ft_memcpy | `void *ft_memcpy(void *dest, const void *src, size_t n)` | copy `n` byte from `src` to `dest` | [x] |
+| ft_memmem | `void *ft_memmem(const void *big, size_t big_len, const void *little, size_t little_len)` | search `little` in `big` | [ ] |
+| ft_memmove | `void *ft_memmove(void *dst, const void *src, size_t len)` | copy `len` byte from `src` to `dst` and the copied memory can overlap | [ ] |
+| ft_memset | `void *ft_memset(void *s, int c, size_t n)` | set `n` byte of `s` to `c` | [x] |
+| ft_memset_pattern4 | `void ft_memset_pattern4(void *b, const void *pattern4, size_t len)` | set `len` byte of `b` to a reapeated pattern of 4 bytes | [ ] |
+| ft_memswap | `void ft_memswap(void *a, void *b, size_t size)` | swap `a` and `b` memory | [x] |
### algo
@@ -71,18 +71,18 @@ Much like the `.gitignore` file, you can put the files/directory to ignore when
### ctype
-| Name | prototype | description | tested |
-|------|-----------|-------------|--------|
-| ft_isalnum | | | |
-| ft_isalpha | | | |
-| ft_isascii | | | |
-| ft_isblank | | | |
-| ft_isdigit | | | |
-| ft_isprint | | | |
-| ft_isspace | | | |
-| ft_todigit | | | |
-| ft_tolower | | | |
-| ft_toupper | | | |
+| Name | Prototype | Description | tested |
+|------------|-------------------------|----------------------------------------------------|--------|
+| ft_isalnum | `int ft_isalnum(int c)` | c is alphanumeric | [x] |
+| ft_isalpha | `int ft_isalpha(int c)` | c is alphabetic | [x] |
+| ft_isascii | `int ft_isascii(int c)` | c is ascii | [x] |
+| ft_isblank | `int ft_isblank(int c)` | c is `\t` ` ` | [x] |
+| ft_isdigit | `int ft_isdigit(int c)` | c is a digit | [x] |
+| ft_isprint | `int ft_isprint(int c)` | c is a printable character | [x] |
+| ft_isspace | `int ft_isspace(int c)` | c is `\t` `\n` `\v` `\f` `\r` ` ` | [x] |
+| ft_todigit | `int ft_todigit(int c)` | convert lower case to upper case | [x] |
+| ft_tolower | `int ft_tolower(int c)` | convert upper case to lower case | [x] |
+| ft_toupper | `int ft_toupper(int c)` | convert digit character to int (-1 if not a digit) | [x] |
### ht
@@ -197,4 +197,3 @@ Much like the `.gitignore` file, you can put the files/directory to ignore when
## School correction state
The state of this project when I turned it in for correction is [here](http://github.com/HappyTramp/libft/tree/raw).
-