# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1456495192 -3600
# Node ID e0853e077770424ad4f508a9a7a6f3f7c9823979
# Parent  2bc19726c3402bc722be190afb8c982e0f9d2c29
removed some implementation details from documentation + fixed ucx_buffer_write doc

diff -r 2bc19726c340 -r e0853e077770 ucx/buffer.h
--- a/ucx/buffer.h	Tue Oct 27 15:29:34 2015 +0100
+++ b/ucx/buffer.h	Fri Feb 26 14:59:52 2016 +0100
@@ -199,7 +199,7 @@
 /**
  * Writes data to an UcxBuffer.
  * 
- * The position of the buffer is increased by the number of bytes read.
+ * The position of the buffer is increased by the number of bytes written.
  * 
  * @param ptr a pointer to the memory area containing the bytes to be written
  * @param size the length of one element
diff -r 2bc19726c340 -r e0853e077770 ucx/mempool.h
--- a/ucx/mempool.h	Tue Oct 27 15:29:34 2015 +0100
+++ b/ucx/mempool.h	Fri Feb 26 14:59:52 2016 +0100
@@ -127,10 +127,8 @@
 /**
  * Reallocates pooled memory.
  * 
- * If the memory to be reallocated is not contained by the specified pool, this
- * function will possibly fail. In case the memory had to be moved to another
- * location, this function will print out a message to <code>stderr</code>
- * and exit the program with error code <code>EXIT_FAILURE</code>.
+ * If the memory to be reallocated is not contained by the specified pool, the
+ * behavior is undefined.
  * 
  * @param pool the memory pool
  * @param ptr a pointer to the memory that shall be reallocated
@@ -146,10 +144,8 @@
  * Before freeing the memory, the specified destructor function (if any)
  * is called.
  * 
- * If you specify memory, that is not pooled by the specified memory pool, this
- * is considered as a severe error and an error message is written to
- * <code>stderr</code> and the application is shut down with code
- * <code>EXIT_FAILURE</code>.
+ * If you specify memory, that is not pooled by the specified memory pool, the
+ * behavior is undefined.
  * 
  * @param pool the memory pool
  * @param ptr a pointer to the memory that shall be freed
diff -r 2bc19726c340 -r e0853e077770 ucx/properties.h
--- a/ucx/properties.h	Tue Oct 27 15:29:34 2015 +0100
+++ b/ucx/properties.h	Fri Feb 26 14:59:52 2016 +0100
@@ -137,8 +137,8 @@
  * 
  * After calling this function, you may parse the data by calling
  * ucx_properties_next() until it returns 0. The function ucx_properties2map()
- * is a convenience function that performs these successive calls of
- * ucx_properties_next() within a while loop and puts the properties to a map.
+ * is a convenience function that reads as much data as possible by using this
+ * function.
  * 
  * 
  * @param prop the UcxProperties object
@@ -185,11 +185,9 @@
 /**
  * Loads a properties file to an UcxMap.
  * 
- * This is a convenience function that reads chunks of 1 KB from an input
+ * This is a convenience function that reads data from an input
  * stream until the end of the stream is reached.
  * 
- * An UcxProperties object is implicitly created and destroyed.
- * 
  * @param map the map object to write the key/value-pairs to
  * @param file the <code>FILE*</code> stream to read from
  * @return 0 on success, or a non-zero value on error