Mercurial > hg > ucx / changeset

     1.1 --- a/ucx/buffer.h	Tue Oct 27 15:29:34 2015 +0100
     1.2 +++ b/ucx/buffer.h	Fri Feb 26 14:59:52 2016 +0100
     1.3 @@ -199,7 +199,7 @@
     1.4  /**
     1.5   * Writes data to an UcxBuffer.
     1.6   * 
     1.7 - * The position of the buffer is increased by the number of bytes read.
     1.8 + * The position of the buffer is increased by the number of bytes written.
     1.9   * 
    1.10   * @param ptr a pointer to the memory area containing the bytes to be written
    1.11   * @param size the length of one element

     2.1 --- a/ucx/mempool.h	Tue Oct 27 15:29:34 2015 +0100
     2.2 +++ b/ucx/mempool.h	Fri Feb 26 14:59:52 2016 +0100
     2.3 @@ -127,10 +127,8 @@
     2.4  /**
     2.5   * Reallocates pooled memory.
     2.6   * 
     2.7 - * If the memory to be reallocated is not contained by the specified pool, this
     2.8 - * function will possibly fail. In case the memory had to be moved to another
     2.9 - * location, this function will print out a message to <code>stderr</code>
    2.10 - * and exit the program with error code <code>EXIT_FAILURE</code>.
    2.11 + * If the memory to be reallocated is not contained by the specified pool, the
    2.12 + * behavior is undefined.
    2.13   * 
    2.14   * @param pool the memory pool
    2.15   * @param ptr a pointer to the memory that shall be reallocated
    2.16 @@ -146,10 +144,8 @@
    2.17   * Before freeing the memory, the specified destructor function (if any)
    2.18   * is called.
    2.19   * 
    2.20 - * If you specify memory, that is not pooled by the specified memory pool, this
    2.21 - * is considered as a severe error and an error message is written to
    2.22 - * <code>stderr</code> and the application is shut down with code
    2.23 - * <code>EXIT_FAILURE</code>.
    2.24 + * If you specify memory, that is not pooled by the specified memory pool, the
    2.25 + * behavior is undefined.
    2.26   * 
    2.27   * @param pool the memory pool
    2.28   * @param ptr a pointer to the memory that shall be freed

     3.1 --- a/ucx/properties.h	Tue Oct 27 15:29:34 2015 +0100
     3.2 +++ b/ucx/properties.h	Fri Feb 26 14:59:52 2016 +0100
     3.3 @@ -137,8 +137,8 @@
     3.4   * 
     3.5   * After calling this function, you may parse the data by calling
     3.6   * ucx_properties_next() until it returns 0. The function ucx_properties2map()
     3.7 - * is a convenience function that performs these successive calls of
     3.8 - * ucx_properties_next() within a while loop and puts the properties to a map.
     3.9 + * is a convenience function that reads as much data as possible by using this
    3.10 + * function.
    3.11   * 
    3.12   * 
    3.13   * @param prop the UcxProperties object
    3.14 @@ -185,11 +185,9 @@
    3.15  /**
    3.16   * Loads a properties file to an UcxMap.
    3.17   * 
    3.18 - * This is a convenience function that reads chunks of 1 KB from an input
    3.19 + * This is a convenience function that reads data from an input
    3.20   * stream until the end of the stream is reached.
    3.21   * 
    3.22 - * An UcxProperties object is implicitly created and destroyed.
    3.23 - * 
    3.24   * @param map the map object to write the key/value-pairs to
    3.25   * @param file the <code>FILE*</code> stream to read from
    3.26   * @return 0 on success, or a non-zero value on error