You will find most of the inline documentation in comments in header files.
Comments in C files are mostly to explain how the code is working, not how it should be used.
An XML document is a list of XML nodes, described by the
An XML document is considered as:
An XML node is basically what lies between the '<' and '>' characters. It is composed of:
<tag attribName="attribValue" ...>
XMLNode struct has pointers to all of these information,
all of them being transparently allocated by sxmlc.
tag_type attribute is an internal representation of the type, for the program
to know how to handle the
Many nodes (e.g. prolog or comments) use the
tag attribute to store its content.
Hence, knowing the tag type eases its display:
<mytag>) is a node that will have children. Nodes read after it will be added as children of this tag.
<mytag/>) is a "self-contained" node that has no children. Nodes read after it are siblings of this tag.
</mytag>) is an ending node that closes its father (if tag names matches). Nodes read after it are siblings of father tag.
XMLNodeassociated with this as it is only used internally by the parser.
<?text?>) is a node used for prolog and processing instructions.
<!--text-->) is a comment node.
<![CDATA[text]]/>) is a CDATA escaped node.
<!DOCTYPE text]/>) is a DOCTYPE node.
user attribute is where you can put any type of data related to the node (e.g. pointer
to a struct, ...).