From 3a64ffd2de26203b2744e1030c876b369731f474 Mon Sep 17 00:00:00 2001 From: Philipp Schafft Date: Fri, 27 Jul 2018 11:44:00 +0000 Subject: [PATCH] Update: Improved comments on reportxml.h --- src/reportxml.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/reportxml.h b/src/reportxml.h index 3732b8c8..2be09dc8 100644 --- a/src/reportxml.h +++ b/src/reportxml.h @@ -60,7 +60,10 @@ typedef enum { REPORTXML_NODE_TYPE_EXTENSION } reportxml_node_type_t; + /* ---[ Document level ]--- */ +/* The document object is NOT thread safe. */ + /* This creates a new, empty report XML document */ reportxml_t * reportxml_new(void); @@ -79,7 +82,10 @@ reportxml_t * reportxml_parse_xmldoc(xmlDocPtr doc); /* This function renders an report XML document as XML structure */ xmlDocPtr reportxml_render_xmldoc(reportxml_t *report); + /* ---[ Node level ]--- */ +/* The node object is NOT thread safe. */ + /* This creates a new node of type type. * It's id, definition, and akindof attributes can be given as parameters. @@ -110,7 +116,10 @@ int reportxml_node_add_xml_child(reportxml_node_t *node, xml ssize_t reportxml_node_count_xml_child(reportxml_node_t *node); xmlNodePtr reportxml_node_get_xml_child(reportxml_node_t *node, size_t idx); + /* ---[ Database level ]--- */ +/* The database object is thread safe. */ + /* Create a new database object */ reportxml_database_t * reportxml_database_new(void);