1
1
mirror of https://github.com/theoludwig/libcproject.git synced 2025-05-21 23:21:15 +02:00

docs: fix doxygen warnings

This commit is contained in:
2023-06-25 21:32:16 +02:00
parent 0c93355e60
commit 074d9e0acb
6 changed files with 46 additions and 52 deletions

View File

@ -13,7 +13,7 @@
/**
* @brief Return the length of a string (excluding '\0').
*
* @param string
* @param string_value
* @since v1.0.0
*/
size_t string_get_length(const string_t string_value);
@ -21,7 +21,7 @@ size_t string_get_length(const string_t string_value);
/**
* @brief Converts all the alphabetic characters in a string to uppercase.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_to_uppercase(string_t string_value);
@ -29,7 +29,7 @@ string_t string_to_uppercase(string_t string_value);
/**
* @brief Converts all the alphabetic characters in a string to lowercase.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_to_lowercase(string_t string_value);
@ -37,9 +37,9 @@ string_t string_to_lowercase(string_t string_value);
/**
* @brief Replace all the occurrences of search value into replace value in the string.
*
* @param string
* @param search_value A character search value.
* @param replace_value A character containing the text to replace for match.
* @param string_value
* @param search A character search value.
* @param replace A character containing the text to replace for match.
* @since v1.0.0
*/
string_t string_replace(string_t string_value, char search, char replace);
@ -47,7 +47,7 @@ string_t string_replace(string_t string_value, char search, char replace);
/**
* @brief Removes all whitespace from the start of a string.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_trim_start(string_t string_value);
@ -55,7 +55,7 @@ string_t string_trim_start(string_t string_value);
/**
* @brief Removes all whitespace from the end of a string.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_trim_end(string_t string_value);
@ -63,7 +63,7 @@ string_t string_trim_end(string_t string_value);
/**
* @brief Removes all whitespace from the start and end of a string.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_trim(string_t string_value);
@ -71,7 +71,7 @@ string_t string_trim(string_t string_value);
/**
* @brief Return the copy of a string.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_copy(const string_t string_value);
@ -79,7 +79,7 @@ string_t string_copy(const string_t string_value);
/**
* @brief Capitalizes the string.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_capitalize(string_t string_value);
@ -87,7 +87,7 @@ string_t string_capitalize(string_t string_value);
/**
* @brief Returns the total number of occurrences of the given character in the string.
*
* @param string
* @param string_value
* @param character
* @since v1.0.0
*/
@ -96,7 +96,7 @@ size_t string_total_occurrences_of_character(string_t string_value, char charact
/**
* @brief Reverse the characters in an array.
*
* @param string
* @param string_value
* @since v1.0.0
*/
string_t string_reverse(const string_t string_value);
@ -114,7 +114,7 @@ bool string_equals(const string_t string1, const string_t string2);
/**
* @brief Check if the string is a integer.
*
* @param string
* @param string_value
* @return true if the string is a integer, false otherwise.
* @since v1.0.0
*/
@ -123,8 +123,9 @@ bool string_get_is_integer(const string_t string_value);
/**
* @brief Split a string into substrings using the specified separator and return them as an array and update the pointer `result_size` to the resulting size of the created array.
*
* @param string
* @param string_value
* @param separator
* @param result_size
* @since v1.0.0
*/
string_t* string_split(const string_t string_value, char separator, size_t* result_size);
@ -134,6 +135,7 @@ string_t* string_split(const string_t string_value, char separator, size_t* resu
*
* @param array
* @param separator
* @param array_length
* @since v1.0.0
*/
string_t string_join(string_t* array, const char separator, size_t array_length);
@ -159,7 +161,7 @@ bool string_get_has_unique_characters(const string_t string);
/**
* @brief Returns the part of the string between the start and end indexes (both included).
*
* @param string
* @param string_value
* @param index_start
* @param index_end
* @since v1.0.0
@ -169,7 +171,7 @@ string_t string_substring(const string_t string_value, size_t index_start, size_
/**
* @brief Check if a string contains a substring.
*
* @param string
* @param string_value
* @param substring
* @return true if the string contains the substring, false otherwise.
* @since v1.0.0
@ -179,16 +181,20 @@ bool string_get_is_substring(const string_t string_value, const string_t substri
/**
* @brief Format a number to a string with specified separator.
*
* @param integer
* @example string_get_formatted_number(1000, " ") // "1 000"
* @param number
* @param separator
* @since v1.0.0
* @code
* string_get_formatted_number(1000, " ") // "1 000"
* string_get_formatted_number(1000, ",") // "1,000"
* @endcode
*/
string_t string_get_formatted_number(const long long number, string_t separator);
/**
* @brief Returns a pointer to the last occurrence of character in the string.
*
* @param string
* @param string_value
* @param character
* @since v1.0.0
*/
@ -197,7 +203,7 @@ string_t string_get_last_occurence_of_character(const string_t string_value, cha
/**
* @brief Check if a string starts with a substring.
*
* @param string
* @param string_value
* @param prefix
* @return true if the string starts with the substring, false otherwise.
* @since v1.0.0
@ -207,7 +213,7 @@ bool string_starts_with(const string_t string_value, const string_t prefix);
/**
* @brief Check if a string ends with a substring.
*
* @param string
* @param string_value
* @param prefix
* @return true if the string ends with the substring, false otherwise.
* @since v1.0.0