Commit d4983562 authored by ionbabalau's avatar ionbabalau Committed by Ernestas Kulik

eel-string: Add description to some eel-string functions

The eel_str_double_underscores and eel_str_capitalize
functions didn't have documentation.
Added importance of eel_str_double_underscores as well.

It's good practice to have documentation for functions
in the long term.
parent 5c974bd8
Pipeline #38068 passed with stages
in 6 minutes and 48 seconds
......@@ -33,6 +33,18 @@
#include "eel-lib-self-check-functions.h"
#endif
/**
* eel_str_double_underscores:
* @string: input string
*
* This is used if you want to preserve underscore characters
* when creating a label with gtk_label_new_with_mnemonic().
*
* Returns: a newly allocated copy of @string,
* with a doubled number of underscores.
* If @string doesn't contain underscores, returns a copy of it.
* If @string is %NULL, returns %NULL.
*/
char *
eel_str_double_underscores (const char *string)
{
......@@ -72,6 +84,14 @@ eel_str_double_underscores (const char *string)
return escaped;
}
/**
* eel_str_capitalize:
* @string: input string
*
* Returns: a newly allocated copy of @string,
* with the first letter capitalized.
* If @string is %NULL, returns %NULL.
*/
char *
eel_str_capitalize (const char *string)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment