Mercurial > hg > toolkit / file diff

--- a/ucx/properties.h	Wed Nov 22 12:59:13 2017 +0100
+++ b/ucx/properties.h	Sun Jan 21 12:13:09 2018 +0100
@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright 2015 Olaf Wintermann. All rights reserved.
+ * Copyright 2016 Olaf Wintermann. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -127,7 +127,7 @@
 UcxProperties *ucx_properties_new();
 
 /**
- * Destroys an UcxProperties object.
+ * Destroys a UcxProperties object.
  * @param prop the UcxProperties object to destroy
  */
 void ucx_properties_free(UcxProperties *prop);
@@ -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
@@ -170,7 +170,7 @@
 int ucx_properties_next(UcxProperties *prop, sstr_t *name, sstr_t *value);
 
 /**
- * Retrieves all available key/value-pairs and puts them into an UcxMap.
+ * Retrieves all available key/value-pairs and puts them into a UcxMap.
  * 
  * This is done by successive calls to ucx_properties_next() until no more
  * key/value-pairs can be retrieved. 
@@ -183,13 +183,11 @@
 int ucx_properties2map(UcxProperties *prop, UcxMap *map);
 
 /**
- * Loads a properties file to an UcxMap.
+ * Loads a properties file to a 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
@@ -200,7 +198,7 @@
 int ucx_properties_load(UcxMap *map, FILE *file);
 
 /**
- * Stores an UcxMap to a file.
+ * Stores a UcxMap to a file.
  * 
  * The key/value-pairs are written by using the following format:
  *