Mercurial > hg > ucx / changeset

--- a/src/ucx/string.h	Wed May 16 18:56:44 2018 +0200
+++ b/src/ucx/string.h	Wed May 16 19:01:21 2018 +0200
@@ -110,7 +110,7 @@
 /**
  * One of two type adjustment functions that return a scstr_t.
  * 
- * Used internally to cast a UCX string to an immutable UCX string.
+ * Used internally to convert a UCX string to an immutable UCX string.
  * This variant is used, when the string is already immutable and no operation
  * needs to be performed.
  * 
@@ -122,7 +122,7 @@
 /**
  * One of two type adjustment functions that return a scstr_t.
  * 
- * Used internally to cast a UCX string to an immutable UCX string.
+ * Used internally to convert a UCX string to an immutable UCX string.
  * 
  * @param str some sstr_t
  * @return an immutable (scstr_t) version of the provided string.
@@ -167,7 +167,7 @@
  * Casts a UCX string to an immutable UCX string (scstr_t).
  * 
  * This internal function (ab)uses the C standard an expects one single
- * argument which is then implicitly casted to scstr_t without a warning.
+ * argument which is then implicitly converted to scstr_t without a warning.
  * 
  * @return the an immutable version of the provided string
  */
@@ -266,7 +266,7 @@
 size_t scstrnlen(size_t count, ...);
 
 /**
- * Alias for scstrnlen() which automatically casts the arguments.
+ * Alias for scstrnlen() which automatically converts the arguments.
  * 
  * @param count    the total number of specified strings (so at least 1)
  * @param ...      all strings
@@ -291,7 +291,7 @@
 sstr_t scstrcat(size_t count, scstr_t s1, ...);
 
 /**
- * Alias for scstrcat() which automatically casts the arguments.
+ * Alias for scstrcat() which automatically converts the arguments.
  * 
  * @param count   the total number of strings to concatenate
  * @param s1      first string
@@ -314,7 +314,7 @@
 sstr_t scstrcat_a(UcxAllocator *a, size_t count, scstr_t s1, ...);
 
 /**
- * Alias for scstrcat_a() which automatically casts the arguments.
+ * Alias for scstrcat_a() which automatically converts the arguments.
  * 
  * See sstrcat() for details.
  *
@@ -471,7 +471,7 @@
 sstr_t scstrsstr(sstr_t string, scstr_t match);
 
 /**
- * Alias for scstrsstr() which automatically casts the match string.
+ * Alias for scstrsstr() which automatically converts the match string.
  * 
  * @param string the string to be scanned
  * @param match  string containing the sequence of characters to match
@@ -499,7 +499,7 @@
 scstr_t scstrscstr(scstr_t string, scstr_t match);
 
 /**
- * Alias for scstrscstr() which automatically casts the match string.
+ * Alias for scstrscstr() which automatically converts the match string.
  * 
  * @param string the string to be scanned
  * @param match  string containing the sequence of characters to match
@@ -559,7 +559,7 @@
 sstr_t* scstrsplit(scstr_t string, scstr_t delim, ssize_t *count);
 
 /**
- * Alias for scstrsplit() which automatically casts the arguments.
+ * Alias for scstrsplit() which automatically converts the arguments.
  * 
  * @param string the string to split
  * @param delim  the delimiter string
@@ -599,7 +599,7 @@
         ssize_t *count);
 
 /**
- * Alias for scstrsplit_a() which automatically casts the arguments.
+ * Alias for scstrsplit_a() which automatically converts the arguments.
  * 
  * @param allocator the UcxAllocator used for allocating memory
  * @param string the string to split
@@ -629,7 +629,7 @@
 int scstrcmp(scstr_t s1, scstr_t s2);
 
 /**
- * Alias for scstrcmp() which automatically casts its arguments.
+ * Alias for scstrcmp() which automatically converts its arguments.
  * 
  * @param s1 the first string
  * @param s2 the second string
@@ -655,7 +655,7 @@
 int scstrcasecmp(scstr_t s1, scstr_t s2);
 
 /**
- * Alias for scstrcasecmp() which automatically casts the arguments.
+ * Alias for scstrcasecmp() which automatically converts the arguments.
  * 
  * @param s1 the first string
  * @param s2 the second string
@@ -682,7 +682,7 @@
 sstr_t scstrdup(scstr_t string);
 
 /**
- * Alias for scstrdup() which automatically casts the argument.
+ * Alias for scstrdup() which automatically converts the argument.
  * 
  * @param string the string to duplicate
  * @return a duplicate of the string
@@ -709,7 +709,7 @@
 sstr_t scstrdup_a(UcxAllocator *allocator, scstr_t string);
 
 /**
- * Alias for scstrdup_a() which automatically casts the argument.
+ * Alias for scstrdup_a() which automatically converts the argument.
  * 
  * @param allocator a valid instance of a UcxAllocator
  * @param string the string to duplicate
@@ -766,7 +766,7 @@
 int scstrprefix(scstr_t string, scstr_t prefix);
 
 /**
- * Alias for scstrprefix() which automatically casts the arguments.
+ * Alias for scstrprefix() which automatically converts the arguments.
  * 
  * @param string the string to check
  * @param prefix the prefix the string should have
@@ -783,7 +783,7 @@
 int scstrsuffix(scstr_t string, scstr_t suffix);
 
 /**
- * Alias for scstrsuffix() which automatically casts the arguments.
+ * Alias for scstrsuffix() which automatically converts the arguments.
  *
  * @param string the string to check
  * @param suffix the suffix the string should have
@@ -804,7 +804,7 @@
 sstr_t scstrlower(scstr_t string);
 
 /**
- * Alias for scstrlower() which automatically casts the argument.
+ * Alias for scstrlower() which automatically converts the argument.
  * 
  * @param string the input string
  * @return the resulting lower case string
@@ -826,7 +826,7 @@
 
 
 /**
- * Alias for scstrlower_a() which automatically casts the argument.
+ * Alias for scstrlower_a() which automatically converts the argument.
  * 
  * @param allocator the allocator used for duplicating the string
  * @param string the input string
@@ -847,7 +847,7 @@
 sstr_t scstrupper(scstr_t string);
 
 /**
- * Alias for scstrupper() which automatically casts the argument.
+ * Alias for scstrupper() which automatically converts the argument.
  * 
  * @param string the input string
  * @return the resulting upper case string
@@ -868,7 +868,7 @@
 sstr_t scstrupper_a(UcxAllocator *allocator, scstr_t string);
 
 /**
- * Alias for scstrupper_a() which automatically casts the argument.
+ * Alias for scstrupper_a() which automatically converts the argument.
  * 
  * @param allocator the allocator used for duplicating the string
  * @param string the input string