aniani/icecast-server
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/icecast-server.git synced 2024-12-04 14:46:30 -05:00
Code

Update: Improved comments on reportxml.h

Browse Source
This commit is contained in:
Philipp Schafft 2018-07-27 11:44:00 +00:00
parent 6f02daafbf
commit 3a64ffd2de
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/reportxml.h
View File

@ -60,7 +60,10 @@ typedef enum {
REPORTXML_NODE_TYPE_EXTENSION REPORTXML_NODE_TYPE_EXTENSION
} reportxml_node_type_t; } reportxml_node_type_t;
/* ---[ Document level ]--- */ /* ---[ Document level ]--- */
/* The document object is NOT thread safe. */
/* This creates a new, empty report XML document */ /* This creates a new, empty report XML document */
reportxml_t * reportxml_new(void); 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 */ /* This function renders an report XML document as XML structure */
xmlDocPtr reportxml_render_xmldoc(reportxml_t *report); xmlDocPtr reportxml_render_xmldoc(reportxml_t *report);
/* ---[ Node level ]--- */ /* ---[ Node level ]--- */
/* The node object is NOT thread safe. */
/* This creates a new node of type type. /* This creates a new node of type type.
* It's id, definition, and akindof attributes can be given as parameters. * 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); ssize_t reportxml_node_count_xml_child(reportxml_node_t *node);
xmlNodePtr reportxml_node_get_xml_child(reportxml_node_t *node, size_t idx); xmlNodePtr reportxml_node_get_xml_child(reportxml_node_t *node, size_t idx);
/* ---[ Database level ]--- */ /* ---[ Database level ]--- */
/* The database object is thread safe. */
/* Create a new database object */ /* Create a new database object */
reportxml_database_t * reportxml_database_new(void); reportxml_database_t * reportxml_database_new(void);