Mercurial > hg > ucx / changeset

     1.1 --- a/ucx/string.h	Fri Jan 17 12:44:54 2014 +0100
     1.2 +++ b/ucx/string.h	Tue Mar 18 09:53:50 2014 +0100
     1.3 @@ -227,7 +227,7 @@
     1.4   * </ul>
     1.5   * 
     1.6   * The integer referenced by <code>count</code> is used as input and determines
     1.7 - * the maximum size of the resulting list, i.e. the maximum count of splits to
     1.8 + * the maximum size of the resulting array, i.e. the maximum count of splits to
     1.9   * perform + 1.
    1.10   * 
    1.11   * The integer referenced by <code>count</code> is also used as output and is
    1.12 @@ -237,24 +237,24 @@
    1.13   *   <li>-1, if either the string or the delimiter is an empty string</li>
    1.14   *   <li>0, if the string equals the delimiter</li>
    1.15   *   <li>1, if the string does not contain the delimiter</li>
    1.16 - *   <li>the count of list items, otherwise</li>
    1.17 + *   <li>the count of array items, otherwise</li>
    1.18   * </ul>
    1.19   * 
    1.20   * If the string starts with the delimiter, the first item of the resulting
    1.21 - * list will be an empty string.
    1.22 + * array will be an empty string.
    1.23   * 
    1.24   * If the string ends with the delimiter and the maximum list size is not
    1.25 - * exceeded, the last list item will be an empty string.
    1.26 + * exceeded, the last array item will be an empty string.
    1.27   * 
    1.28 - * <b>Attention:</b> All list items <b>AND</b> all sstr_t.ptr of the list
    1.29 + * <b>Attention:</b> The array pointer <b>AND</b> all sstr_t.ptr of the array
    1.30   * items must be manually passed to <code>free()</code>. Use sstrsplit_a() with
    1.31   * an allocator to managed memory, to avoid this.
    1.32   *
    1.33   * @param string the string to split
    1.34   * @param delim  the delimiter string
    1.35 - * @param count  IN: the maximum size of the resulting list (0 for an
    1.36 - *               unbounded list), OUT: the actual size of the list
    1.37 - * @return a list of the split strings as sstr_t array or
    1.38 + * @param count  IN: the maximum size of the resulting array (0 = no limit),
    1.39 + *               OUT: the actual size of the array
    1.40 + * @return a sstr_t array containing the split strings or
    1.41   *         <code>NULL</code> on error
    1.42   * 
    1.43   * @see sstrsplit_a()
    1.44 @@ -266,7 +266,7 @@
    1.45   * 
    1.46   * <i>Read the description of sstrsplit() for details.</i>
    1.47   * 
    1.48 - * The memory for the sstr_t.ptr pointers of the list items and the memory for
    1.49 + * The memory for the sstr_t.ptr pointers of the array items and the memory for
    1.50   * the sstr_t array itself are allocated by using the UcxAllocator.malloc()
    1.51   * function.
    1.52   * 
    1.53 @@ -276,9 +276,9 @@
    1.54   * @param allocator the UcxAllocator used for allocating memory
    1.55   * @param string the string to split
    1.56   * @param delim  the delimiter string
    1.57 - * @param count  IN: the maximum size of the resulting list (0 for an
    1.58 - *               unbounded list), OUT: the actual size of the list
    1.59 - * @return a list of the split strings as sstr_t array or
    1.60 + * @param count  IN: the maximum size of the resulting array (0 = no limit),
    1.61 + *               OUT: the actual size of the array
    1.62 + * @return a sstr_t array containing the split strings or
    1.63   *         <code>NULL</code> on error
    1.64   * 
    1.65   * @see sstrsplit()