ucx/properties.h

changeset 17
11dffb40cd91
parent 5
88625853ae74
child 70
88092b88ec00
--- a/ucx/properties.h	Fri Aug 16 12:41:30 2013 +0200
+++ b/ucx/properties.h	Sat Aug 17 12:04:04 2013 +0200
@@ -56,52 +56,62 @@
      * Automatically set by calls to ucx_properties_fill().
      */
     char   *buffer;
+    
     /**
      * Length of the input buffer (don't set manually).
      * Automatically set by calls to ucx_properties_fill().
      */
     size_t buflen;
+    
     /**
      * Current buffer position (don't set manually).
      * Used by ucx_properties_next().
      */
     size_t pos;
+    
     /**
      * Internal temporary buffer (don't set manually).
      * Used by ucx_properties_next().
      */
     char   *tmp;
+    
     /**
      * Internal temporary buffer length (don't set manually).
      * Used by ucx_properties_next().
      */
     size_t tmplen;
+    
     /**
      * Internal temporary buffer capacity (don't set manually).
      * Used by ucx_properties_next().
      */
     size_t tmpcap;
+    
     /**
      * Parser error code.
      * This is always 0 on success and a nonzero value on syntax errors.
      * The value is set by ucx_properties_next().
      */
     int    error;
+    
     /**
      * The delimiter that shall be used.
      * This is '=' by default.
      */
     char   delimiter;
+    
     /**
      * The first comment character.
      * This is '#' by default.
      */
     char   comment1;
+    
     /**
      * The second comment character.
      * This is not set by default.
      */
     char   comment2;
+    
     /**
      * The third comment character.
      * This is not set by default.
@@ -115,11 +125,13 @@
  * @return a pointer to the new UcxProperties object
  */
 UcxProperties *ucx_properties_new();
+
 /**
  * Destroys an UcxProperties object.
  * @param prop the UcxProperties object to destroy
  */
 void ucx_properties_free(UcxProperties *prop);
+
 /**
  * Sets the input buffer for the properties parser.
  * 
@@ -136,6 +148,7 @@
  * @see ucx_properties2map()
  */
 void ucx_properties_fill(UcxProperties *prop, char *buf, size_t len);
+
 /**
  * Retrieves the next key/value-pair.
  * 
@@ -155,6 +168,7 @@
  * @see ucx_properties_fill()
  */
 int ucx_properties_next(UcxProperties *prop, sstr_t *name, sstr_t *value);
+
 /**
  * Retrieves all available key/value-pairs and puts them into an UcxMap.
  * 
@@ -184,6 +198,7 @@
  * @see ucx_properties2map()
  */
 int ucx_properties_load(UcxMap *map, FILE *file);
+
 /**
  * Stores an UcxMap to a file.
  * 

mercurial