aboutsummarylogtreecommitdiffstats
path: root/string-tick.h
diff options
context:
space:
mode:
Diffstat (limited to 'string-tick.h')
-rw-r--r--string-tick.h15
1 files changed, 9 insertions, 6 deletions
diff --git a/string-tick.h b/string-tick.h
index 1397ee3fb2ef..7f6785a8e970 100644
--- a/string-tick.h
+++ b/string-tick.h
@@ -16,36 +16,39 @@ typedef struct string String;
typedef struct json_object Json;
/**
- * Creates and returns a STRING
- * object with size 1 and no data
+ * Creates and returns a String object with len 1 and no data
* @return STRING object
*/
String* string_init(void);
/**
- * Changes letters in a string to lowercase
+ * Changes letters in a string to lowercase in place
* @param str the string
*/
void strtolower(char* str);
/**
- * Changes letters in a string to uppercase
+ * Changes letters in a string to uppercase in place
* @param str the string
*/
void strtoupper(char* str);
/**
- * Returns the input string, stripped of the given char
+ * Returns the input string, stripped of the given char c in place
* @param string the string to strip the char from
* @param c the char to strip
* @return input string
*/
char* strip_char(char* string, char c);
+/**
+ * Overwrites the portfolio with the given pString
+ * @param pString the String to overwrite with
+ */
void string_write_portfolio(String* pString);
/**
- * Destroys String object and frees memory
+ * Destroys String object and frees memory. Points the String to NULL.
* @param phString the String to destroy
*/
void string_destroy(String** phString);