commit 5eaf664c617dd8b33047b9e86903fd86f059d7c4
parent 82fa25e346865aa1f1118169bb21d1b986dda105
Author: Joris Vink <joris@coders.se>
Date: Tue, 9 Oct 2018 15:34:29 +0200
remove bad characters
Diffstat:
4 files changed, 24 insertions(+), 27 deletions(-)
diff --git a/api/buffers.md b/api/buffers.md
@@ -104,7 +104,7 @@ Append data given in the form of a format and a variadic argument list.
| -- | -- |
| buf | The buffer. |
| fmt | The format string. |
-| args | Variadic argument list. |
+| args | Variadic argument list. |
### Returns
@@ -123,8 +123,8 @@ Append data given in the form of a string format and list of arguments. Much lik
| Parameter | Description |
| -- | -- |
| buf | The buffer. |
-| fmt | The format string. |
-| ... | Any arguments for the format string. |
+| fmt | The format string. |
+| ... | Any arguments for the format string. |
### Returns
Nothing
diff --git a/api/miscellaneous.md b/api/miscellaneous.md
@@ -17,7 +17,7 @@ Note that when running in the foreground these go to stdout.
| Parameter | Description |
| -- | -- |
| prio | The priority of the log message (see syslog(3)). |
-| fmt | The format string. |
+| fmt | The format string. |
| ... | List of arguments. |
### Returns
@@ -36,8 +36,8 @@ Bounded C string copying. The result is always NUL-terminated.
| Parameter | Description |
| -- | -- |
| dst | The destination buffer. |
-| src | The source C string. |
-| length | The maximum number of bytes that the destination buffer holds. |
+| src | The source C string. |
+| length | The maximum number of bytes that the destination buffer holds. |
### Returns
The length of the original string. If this length is equal or larger then the destination buffer then truncation of the string has occurred.
@@ -54,11 +54,11 @@ Safely convert a C string holding a number into an integer.
| Parameter | Description |
| -- | -- |
-| str | The C string to convert. |
-| base | The base on which to operate. |
-| min | The minimum value the converted integer is allowed to have. |
-| max | The maximum value the converted integer is allowed to have. |
-| err | A pointer to an integer that holds the error value. |
+| str | The C string to convert. |
+| base | The base on which to operate. |
+| min | The minimum value the converted integer is allowed to have. |
+| max | The maximum value the converted integer is allowed to have. |
+| err | A pointer to an integer that holds the error value. |
### Returns
Returns the converted integer. If the *err* parameter was set to KORE_RESULT_OK the conversion went OK otherwise there was an error and the returned value is considered garbage.
@@ -115,10 +115,10 @@ Safely strip all occurences of a certain character from a C string. The result m
| Parameter | Description |
| -- | -- |
| in | The input C string. |
-| strip | The character to be stripped out of the string. |
+| strip | The character to be stripped out of the string. |
| out | A pointer to where the new result is stored. |
### Returns
Nothing
-----
\ No newline at end of file
+---
diff --git a/api/pools.md b/api/pools.md
@@ -17,7 +17,7 @@ Initializes a new pool.
| Parameter | Description |
| -- | -- |
| pool | A pointer to a pool. |
-| name | The name to give to the pool. This name is shown in the logs if the pool is exhausted. |
+| name | The name to give to the pool. This name is shown in the logs if the pool is exhausted. |
| len | The size in bytes of each element. |
| elm | The number of initial elements to preallocate to the pool. |
@@ -76,4 +76,4 @@ Returns the given pointer back to its pool.
### Returns
Nothing
-----
\ No newline at end of file
+---
diff --git a/api/tasks.md b/api/tasks.md
@@ -19,7 +19,7 @@ Creates a new task which when run will call the given callback.
| Parameter | Description |
| -- | -- |
| t | A task data structure. |
-| entry | The entry point of the task when run. |
+| entry | The entry point of the task when run. |
### Returns
Nothing
@@ -53,8 +53,8 @@ Using this in combination with the HTTP state machine allows you to build reques
| Parameter | Description |
| -- | -- |
-| t | A task data structure. |
-| req | The HTTP request to be bound to the task. |
+| t | A task data structure. |
+| req | The HTTP request to be bound to the task. |
### Returns
Nothing
@@ -87,7 +87,7 @@ Destroys a task.
| Parameter | Description |
| -- | -- |
-| t | A task data structure. |
+| t | A task data structure. |
### Returns
Nothing
@@ -103,7 +103,7 @@ Check if a task has finished running.
| Parameter | Description |
| -- | -- |
-| t | A task data structure. |
+| t | A task data structure. |
### Returns
Returns 1 if the task has finished running, otherwise 0.
@@ -119,9 +119,9 @@ Write data on the task channel for the other end to read. This works both from t
| Parameter | Description |
| -- | -- |
-| t | A task data structure. |
-| data | The data to be written on the channel. |
-| length | The length of the data to be written. |
+| t | A task data structure. |
+| data | The data to be written on the channel. |
+| length | The length of the data to be written. |
### Returns
Nothing
@@ -148,4 +148,4 @@ NOTE: This is a blocking operation.
Returns the number of original bytes from the message, if this is larger then
the *length* parameter then truncation has occurred.
-----
\ No newline at end of file
+---
