documentation adaption
authorVolker Birk <vb@pep.foundation>
Mon, 17 Oct 2016 15:35:48 +0200
changeset 1285e9015701a9b4
parent 1284 ced04ed25f9b
child 1286 278339f8066c
documentation adaption
src/stringpair.c
src/stringpair.h
     1.1 --- a/src/stringpair.c	Mon Oct 17 15:30:18 2016 +0200
     1.2 +++ b/src/stringpair.c	Mon Oct 17 15:35:48 2016 +0200
     1.3 @@ -10,6 +10,8 @@
     1.4  {
     1.5      stringpair_t *pair = NULL;
     1.6  
     1.7 +    // key and value should not be NULL, that's bad style (while legal)
     1.8 +
     1.9      assert(key);
    1.10      assert(value);
    1.11  
     2.1 --- a/src/stringpair.h	Mon Oct 17 15:30:18 2016 +0200
     2.2 +++ b/src/stringpair.h	Mon Oct 17 15:35:48 2016 +0200
     2.3 @@ -16,8 +16,8 @@
     2.4  // new_stringpair() - allocate new stringpair_t
     2.5  //
     2.6  //  parameters:
     2.7 -//      key (in)        utf-8 string used as key; may point to "" but must not be NULL!
     2.8 -//      value (in)      utf-8 string containing the value; may point to "" but must not be NULL!
     2.9 +//      key (in)        utf-8 string used as key, should not be NULL
    2.10 +//      value (in)      utf-8 string containing the value, should not be NULL
    2.11  //
    2.12  //  return value:
    2.13  //      pointer to stringpair_t or NULL on failure