X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e7eb3a2744aa45179daea235800753d3d1955338..4265e5d362914f3732b4035dcf67162e525e0142:/lib/kvp.h diff --git a/lib/kvp.h b/lib/kvp.h index 7b41837..0a7e478 100644 --- a/lib/kvp.h +++ b/lib/kvp.h @@ -15,6 +15,9 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ +/** @file lib/kvp.h + * @brief Linked list of key-value pairs + */ #ifndef KVP_H #define KVP_H @@ -22,10 +25,22 @@ struct dynstr; struct sink; +/** @brief Linked list of key-value pairs */ struct kvp { - struct kvp *next; /* next entry */ - const char *name; /* name */ - const char *value; /* value */ + /** @brief Next entry */ + struct kvp *next; + + /** @brief Name + * + * Might not be unique. Must not be null. + */ + const char *name; + + /** @brief Value + * + * Must not be null. + */ + const char *value; }; struct kvp *kvp_urldecode(const char *ptr, size_t n);