Mercurial > trustbridge
comparison common/strhelp.h @ 1304:82fab0c689bf 0.9.3
Fix doxygen syntax error. Change inout to in,out
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Mon, 29 Sep 2014 16:42:06 +0200 |
| parents | ffdc8cba139a |
| children |
comparison
equal
deleted
inserted
replaced
| 1303:78637257f547 | 1304:82fab0c689bf |
|---|---|
| 47 unsigned int strv_length (char **str_array); | 47 unsigned int strv_length (char **str_array); |
| 48 | 48 |
| 49 /** | 49 /** |
| 50 * @brief append a string to a NULL terminated array of strings. | 50 * @brief append a string to a NULL terminated array of strings. |
| 51 * | 51 * |
| 52 * @param[inout] pArray pointer to the NULL terminated list of string pointers. | 52 * @param[in,out] pArray pointer to the NULL terminated list of string pointers. |
| 53 * @param[in] string pointer to the string to append to the list. | 53 * @param[in] string pointer to the string to append to the list. |
| 54 * @param[in] len length of the string to append to the list | 54 * @param[in] len length of the string to append to the list |
| 55 */ | 55 */ |
| 56 void strv_append (char ***pArray, const char *string, const size_t len); | 56 void strv_append (char ***pArray, const char *string, const size_t len); |
| 57 | 57 |
| 58 /** | 58 /** |
| 59 * @brief append a string to another string. | 59 * @brief append a string to another string. |
| 60 * | 60 * |
| 61 * @param[inout] pDst pointer to the string to be extended. | 61 * @param[in,out] pDst pointer to the string to be extended. |
| 62 * @param[inout] dst_len length of the dst string. Will be modified. | 62 * @param[in,out] dst_len length of the dst string. Will be modified. |
| 63 * @param[in] appendage pointer to the string to append. | 63 * @param[in] appendage pointer to the string to append. |
| 64 * @param[in] len length of the string to append. | 64 * @param[in] len length of the string to append. |
| 65 */ | 65 */ |
| 66 void str_append_str (char **pDst, size_t *dst_len, const char *appendage, | 66 void str_append_str (char **pDst, size_t *dst_len, const char *appendage, |
| 67 const size_t len); | 67 const size_t len); |
| 68 | 68 |
| 69 /** | 69 /** |
| 70 * @brief Frees the given %NULL-terminated string array. | 70 * @brief Frees the given %NULL-terminated string array. |
| 71 * @param[inout] str_array a %NULL-terminated array of strings | 71 * @param[in,out] str_array a %NULL-terminated array of strings |
| 72 */ | 72 */ |
| 73 void strv_free (char **str_array); | 73 void strv_free (char **str_array); |
| 74 | 74 |
| 75 /** | 75 /** |
| 76 * @brief Checks whether two strings exactly match | 76 * @brief Checks whether two strings exactly match |
| 91 /** | 91 /** |
| 92 * @brief Trims all white space from the start and end of string. | 92 * @brief Trims all white space from the start and end of string. |
| 93 * @details the start of the string is trimmed by setting *s to the | 93 * @details the start of the string is trimmed by setting *s to the |
| 94 * first non white space character. The end is trimmed by setting the | 94 * first non white space character. The end is trimmed by setting the |
| 95 * first character after the last non white space character to \0. | 95 * first character after the last non white space character to \0. |
| 96 * @param[inout] s ponter to the string to strip | 96 * @param[in,out] s ponter to the string to strip |
| 97 */ | 97 */ |
| 98 bool str_trim (char **s); | 98 bool str_trim (char **s); |
| 99 | 99 |
| 100 /** @brief decode base64 encoded data | 100 /** @brief decode base64 encoded data |
| 101 * | 101 * |