theoludwig/libcproject
theoludwig/libcproject
1
1
Fork 0
mirror of https://github.com/theoludwig/libcproject.git synced 2024-12-11 21:13:00 +01:00
Code Issues Releases Activity

chore: remove useless @return

Browse Source
This commit is contained in:
Théo LUDWIG 2023-06-25 15:10:51 +02:00
parent a0140a6716
commit 5f60abc759
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
4 changed files with 0 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/character.h
View File

@ -31,7 +31,6 @@ void character_append_at(string_t string_value, const char character, const size
* @brief Converts the character to uppercase. * @brief Converts the character to uppercase.
* *
* @param character * @param character
* @return const char
* @since v1.0.0 * @since v1.0.0
*/ */
char character_to_upper(const char character); char character_to_upper(const char character);
@ -40,7 +39,6 @@ char character_to_upper(const char character);
* @brief Converts the character to lowercase. * @brief Converts the character to lowercase.
* *
* @param character * @param character
* @return const char
* @since v1.0.0 * @since v1.0.0
*/ */
char character_to_lower(const char character); char character_to_lower(const char character);
@ -60,7 +58,6 @@ bool character_get_is_digit(const char character);
* Return 0 if the character is not a letter. * Return 0 if the character is not a letter.
* *
* @param character * @param character
* @return char
* @since v1.0.0 * @since v1.0.0
*/ */
unsigned char character_get_alphabet_position(const char character); unsigned char character_get_alphabet_position(const char character);

2
lib/filesystem.h
View File

@ -19,7 +19,6 @@
* @param path * @param path
* @param file_content * @param file_content
* @param file_size * @param file_size
* @return int
* @retval -1 if the file does not exist or if there is an error. * @retval -1 if the file does not exist or if there is an error.
* @retval 0 for success. * @retval 0 for success.
* @since v1.0.0 * @since v1.0.0
@ -32,7 +31,6 @@ int filesystem_read(string_t path, byte_t **file_content, off_t *file_size);
* @param path * @param path
* @param file_content * @param file_content
* @param file_size * @param file_size
* @return int
* @retval -1 if there is an error. * @retval -1 if there is an error.
* @retval 0 for success. * @retval 0 for success.
* @since v1.0.0 * @since v1.0.0

5
lib/mathematics.h
View File

@ -20,7 +20,6 @@ bool mathematics_equals(const float number1, const float number2);
* @brief Get the absolute value of a number. * @brief Get the absolute value of a number.
* *
* @param number * @param number
* @return unsigned long long
* @since v1.0.0 * @since v1.0.0
*/ */
unsigned long long mathematics_absolute_value(const long long number); unsigned long long mathematics_absolute_value(const long long number);
@ -30,7 +29,6 @@ unsigned long long mathematics_absolute_value(const long long number);
* *
* @param base * @param base
* @param exponent * @param exponent
* @return unsigned long long
* @since v1.0.0 * @since v1.0.0
*/ */
unsigned long long mathematics_pow(unsigned long long base, unsigned long long exponent); unsigned long long mathematics_pow(unsigned long long base, unsigned long long exponent);
@ -40,7 +38,6 @@ unsigned long long mathematics_pow(unsigned long long base, unsigned long long e
* *
* @param number * @param number
* @param nth_root * @param nth_root
* @return float
* @since v1.0.0 * @since v1.0.0
*/ */
float mathematics_root(float number, unsigned int nth_root); float mathematics_root(float number, unsigned int nth_root);
@ -49,7 +46,6 @@ float mathematics_root(float number, unsigned int nth_root);
* @brief Calculates the square root of a number using Heron's method. * @brief Calculates the square root of a number using Heron's method.
* *
* @param number * @param number
* @return float
* @since v1.0.0 * @since v1.0.0
*/ */
float mathematics_square_root(float number); float mathematics_square_root(float number);
@ -58,7 +54,6 @@ float mathematics_square_root(float number);
* @brief Calculates the factorial of a number. * @brief Calculates the factorial of a number.
* *
* @param number * @param number
* @return unsigned long long
* @since v1.0.0 * @since v1.0.0
*/ */
unsigned long long mathematics_factorial(unsigned long long number); unsigned long long mathematics_factorial(unsigned long long number);

2
lib/string.h
View File

@ -14,7 +14,6 @@
* @brief Return the length of a string (excluding '\0'). * @brief Return the length of a string (excluding '\0').
* *
* @param string * @param string
* @return size_t
* @since v1.0.0 * @since v1.0.0
*/ */
size_t string_get_length(const string_t string_value); size_t string_get_length(const string_t string_value);
@ -90,7 +89,6 @@ string_t string_capitalize(string_t string_value);
* *
* @param string * @param string
* @param character * @param character
* @return size_t
* @since v1.0.0 * @since v1.0.0
*/ */
size_t string_total_occurrences_of_character(string_t string_value, char character); size_t string_total_occurrences_of_character(string_t string_value, char character);