diff --git a/doc/reference.html b/doc/reference.html index 9168bb1..40ef81e 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -27,7 +27,7 @@
  • mxml_type_e
  • -

    mxml_type_e

    +

    mxml_type_e

    Description

    The XML node type.

    Values

    @@ -89,7 +89,7 @@
  • mxmlWalkPrev()
  • -

    mxmlAdd()

    +

    mxmlAdd()

    Description

    Add a node to a tree. @@ -120,7 +120,7 @@ mxmlAdd(

    Returns

    Nothing.

    -

    mxmlDelete()

    +

    mxmlDelete()

    Description

    Delete a node and all of its children. @@ -141,7 +141,7 @@ mxmlDelete(

    Returns

    Nothing.

    -

    mxmlElementGetAttr()

    +

    mxmlElementGetAttr()

    Description

    Get an attribute. @@ -164,7 +164,7 @@ mxmlElementGetAttr(

    Returns

    Attribute value or NULL

    -

    mxmlElementSetAttr()

    +

    mxmlElementSetAttr()

    Description

    Set an attribute. @@ -191,7 +191,7 @@ mxmlElementSetAttr(

    Returns

    Nothing.

    -

    mxmlEntityAddCallback()

    +

    mxmlEntityAddCallback()

    Description

    Add a callback to convert entities to Unicode.

    Syntax

    @@ -204,7 +204,7 @@ mxmlEntityAddCallback(void);

    Returns

    0 on success, -1 on failure

    -

    mxmlEntityGetName()

    +

    mxmlEntityGetName()

    Description

    Get the name that corresponds to the character value. @@ -224,7 +224,7 @@ mxmlEntityGetName(

    Returns

    Entity name or NULL

    -

    mxmlEntityGetValue()

    +

    mxmlEntityGetValue()

    Description

    Get the character corresponding to a named entity. @@ -245,7 +245,7 @@ mxmlEntityGetValue(

    Returns

    Character value or -1 on error

    -

    mxmlEntityRemoveCallback()

    +

    mxmlEntityRemoveCallback()

    Description

    Remove a callback.

    Syntax

    @@ -258,7 +258,7 @@ mxmlEntityRemoveCallback(void);

    Returns

    Nothing.

    -

    mxmlFindElement()

    +

    mxmlFindElement()

    Description

    Find the named element. @@ -295,7 +295,7 @@ mxmlFindElement(

    Returns

    Element node or NULL

    -

    mxmlIndexDelete()

    +

    mxmlIndexDelete()

    Description

    Delete an index.

    Syntax

    @@ -313,7 +313,7 @@ mxmlIndexDelete(

    Returns

    Nothing.

    -

    mxmlIndexEnum()

    +

    mxmlIndexEnum()

    Description

    Return the next node in the index. @@ -333,7 +333,7 @@ mxmlIndexEnum(

    Returns

    Next node or NULL if there is none

    -

    mxmlIndexFind()

    +

    mxmlIndexFind()

    Description

    Find the next matching node. @@ -360,7 +360,7 @@ mxmlIndexFind(

    Returns

    Node or NULL if none found

    -

    mxmlIndexNew()

    +

    mxmlIndexNew()

    Description

    Create a new index. @@ -388,7 +388,7 @@ mxmlIndexNew(

    Returns

    New index

    -

    mxmlIndexReset()

    +

    mxmlIndexReset()

    Description

    Reset the enumeration/find pointer in the index and return the first node in the index. @@ -410,7 +410,7 @@ mxmlIndexReset(

    Returns

    First node or NULL if there is none

    -

    mxmlLoadFd()

    +

    mxmlLoadFd()

    Description

    Load a file descriptor into an XML node tree. @@ -441,7 +441,7 @@ mxmlLoadFd(

    Returns

    First node or NULL if the file could not be read.

    -

    mxmlLoadFile()

    +

    mxmlLoadFile()

    Description

    Load a file into an XML node tree. @@ -472,7 +472,7 @@ mxmlLoadFile(

    Returns

    First node or NULL if the file could not be read.

    -

    mxmlLoadString()

    +

    mxmlLoadString()

    Description

    Load a string into an XML node tree. @@ -503,7 +503,7 @@ mxmlLoadString(

    Returns

    First node or NULL if the string has errors.

    -

    mxmlNewCDATA()  Mini-XML 2.3 

    +

     Mini-XML 2.3 mxmlNewCDATA()

    Description

    Create a new CDATA node. @@ -530,7 +530,7 @@ mxmlNewCDATA(

    Returns

    New node

    -

    mxmlNewCustom()  Mini-XML 2.1 

    +

     Mini-XML 2.1 mxmlNewCustom()

    Description

    Create a new custom data node. @@ -557,7 +557,7 @@ mxmlNewCustom(

    Returns

    New node

    -

    mxmlNewElement()

    +

    mxmlNewElement()

    Description

    Create a new element node. @@ -581,7 +581,7 @@ mxmlNewElement(

    Returns

    New node

    -

    mxmlNewInteger()

    +

    mxmlNewInteger()

    Description

    Create a new integer node. @@ -605,7 +605,7 @@ mxmlNewInteger(

    Returns

    New node

    -

    mxmlNewOpaque()

    +

    mxmlNewOpaque()

    Description

    Create a new opaque string. @@ -630,7 +630,7 @@ mxmlNewOpaque(

    Returns

    New node

    -

    mxmlNewReal()

    +

    mxmlNewReal()

    Description

    Create a new real number node. @@ -654,7 +654,7 @@ mxmlNewReal(

    Returns

    New node

    -

    mxmlNewText()

    +

    mxmlNewText()

    Description

    Create a new text fragment node. @@ -682,7 +682,7 @@ mxmlNewText(

    Returns

    New node

    -

    mxmlNewTextf()

    +

    mxmlNewTextf()

    Description

    Create a new formatted text fragment node. @@ -712,7 +712,7 @@ mxmlNewTextf(

    Returns

    New node

    -

    mxmlRemove()

    +

    mxmlRemove()

    Description

    Remove a node from its parent. @@ -733,7 +733,7 @@ mxmlRemove(

    Returns

    Nothing.

    -

    mxmlSaveAllocString()

    +

    mxmlSaveAllocString()

    Description

    Save an XML node tree to an allocated string. @@ -763,7 +763,7 @@ mxmlSaveAllocString(

    Returns

    Allocated string or NULL

    -

    mxmlSaveFd()

    +

    mxmlSaveFd()

    Description

    Save an XML tree to a file descriptor. @@ -789,7 +789,7 @@ mxmlSaveFd(

    Returns

    0 on success, -1 on error.

    -

    mxmlSaveFile()

    +

    mxmlSaveFile()

    Description

    Save an XML tree to a file. @@ -815,7 +815,7 @@ mxmlSaveFile(

    Returns

    0 on success, -1 on error.

    -

    mxmlSaveString()

    +

    mxmlSaveString()

    Description

    Save an XML node tree to a string. @@ -847,7 +847,7 @@ mxmlSaveString(

    Returns

    Size of string

    -

    mxmlSetCDATA()  Mini-XML 2.3 

    +

     Mini-XML 2.3 mxmlSetCDATA()

    Description

    Set the element name of a CDATA node. @@ -871,7 +871,7 @@ mxmlSetCDATA(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetCustom()  Mini-XML 2.1 

    +

     Mini-XML 2.1 mxmlSetCustom()

    Description

    Set the data and destructor of a custom data node. @@ -895,7 +895,7 @@ mxmlSetCustom(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetCustomHandlers()

    +

    mxmlSetCustomHandlers()

    Description

    Set the handling functions for custom data. @@ -921,7 +921,7 @@ mxmlSetCustomHandlers(

    Returns

    Nothing.

    -

    mxmlSetElement()

    +

    mxmlSetElement()

    Description

    Set the name of an element node. @@ -943,7 +943,7 @@ mxmlSetElement(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetErrorCallback()

    +

    mxmlSetErrorCallback()

    Description

    Set the error message callback.

    Syntax

    @@ -956,7 +956,7 @@ mxmlSetErrorCallback(void);

    Returns

    Nothing.

    -

    mxmlSetInteger()

    +

    mxmlSetInteger()

    Description

    Set the value of an integer node. @@ -978,7 +978,7 @@ mxmlSetInteger(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetOpaque()

    +

    mxmlSetOpaque()

    Description

    Set the value of an opaque node. @@ -1000,7 +1000,7 @@ mxmlSetOpaque(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetReal()

    +

    mxmlSetReal()

    Description

    Set the value of a real number node. @@ -1022,7 +1022,7 @@ mxmlSetReal(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetText()

    +

    mxmlSetText()

    Description

    Set the value of a text node. @@ -1046,7 +1046,7 @@ mxmlSetText(

    Returns

    0 on success, -1 on failure

    -

    mxmlSetTextf()

    +

    mxmlSetTextf()

    Description

    Set the value of a text node to a formatted string. @@ -1072,7 +1072,7 @@ mxmlSetTextf(

    Returns

    0 on success, -1 on failure

    -

    mxmlWalkNext()

    +

    mxmlWalkNext()

    Description

    Walk to the next logical node in the tree. @@ -1098,7 +1098,7 @@ mxmlWalkNext(

    Returns

    Next node or NULL

    -

    mxmlWalkPrev()

    +

    mxmlWalkPrev()

    Description

    Walk to the previous logical node in the tree. @@ -1134,7 +1134,7 @@ mxmlWalkPrev(

  • mxml_text_s
  • -

    mxml_attr_s

    +

    mxml_attr_s

    Description

    Data types...

    Definition

    @@ -1153,7 +1153,7 @@ struct mxml_attr_s value Attribute value -

    mxml_custom_s  Mini-XML 2.1 

    +

     Mini-XML 2.1 mxml_custom_s

    Description

    An XML custom value.

    Definition

    @@ -1170,7 +1170,7 @@ struct mxml_custom_s data Pointer to (allocated) custom data -

    mxml_element_s

    +

    mxml_element_s

    Description

    An XML element value.

    Definition

    @@ -1191,7 +1191,7 @@ struct mxml_element_s num_attrs Number of attributes -

    mxml_index_s

    +

    mxml_index_s

    Description

    An XML node index.

    Definition

    @@ -1216,7 +1216,7 @@ struct mxml_index_s num_nodes Number of nodes in index -

    mxml_node_s

    +

    mxml_node_s

    Description

    An XML node.

    Definition

    @@ -1245,7 +1245,7 @@ struct mxml_node_s value Node value -

    mxml_text_s

    +

    mxml_text_s

    Description

    An XML text value.

    Definition

    @@ -1277,7 +1277,7 @@ struct mxml_text_s
  • mxml_value_t
  • -

    mxml_attr_t

    +

    mxml_attr_t

    Description

    Data types...

    Definition

    @@ -1285,7 +1285,7 @@ struct mxml_text_s typedef struct mxml_attr_s mxml_attr_t; -

    mxml_custom_load_cb_t

    +

    mxml_custom_load_cb_t

    Description

    Custom data load callback function

    Definition

    @@ -1293,7 +1293,7 @@ typedef struct mxml_attr_s mxml_attr_t; typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, const char *); -

    mxml_custom_save_cb_t

    +

    mxml_custom_save_cb_t

    Description

    Custom data save callback function

    Definition

    @@ -1301,7 +1301,7 @@ typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, c typedef char * (*mxml_custom_save_cb_t)(mxml_node_t *); -

    mxml_custom_t  Mini-XML 2.1 

    +

     Mini-XML 2.1 mxml_custom_t

    Description

    An XML custom value.

    Definition

    @@ -1309,7 +1309,7 @@ typedef char * (*mxml_custom_save_cb_t)(mxml_node_t * typedef struct mxml_custom_s mxml_custom_t; -

    mxml_element_t

    +

    mxml_element_t

    Description

    An XML element value.

    Definition

    @@ -1317,7 +1317,7 @@ typedef struct mxml_custom_s mxml_custom_t; typedef struct mxml_element_s mxml_element_t; -

    mxml_index_t

    +

    mxml_index_t

    Description

    An XML node index.

    Definition

    @@ -1325,7 +1325,7 @@ typedef struct mxml_element_s mxml_element_t; typedef struct mxml_index_s mxml_index_t; -

    mxml_node_t

    +

    mxml_node_t

    Description

    An XML node.

    Definition

    @@ -1333,7 +1333,7 @@ typedef struct mxml_index_s mxml_index_t; typedef struct mxml_node_s mxml_node_t; -

    mxml_text_t

    +

    mxml_text_t

    Description

    An XML text value.

    Definition

    @@ -1341,7 +1341,7 @@ typedef struct mxml_node_s mxml_node_t; typedef struct mxml_text_s mxml_text_t; -

    mxml_value_t

    +

    mxml_value_t

    Description

    An XML node value.

    Definition

    @@ -1354,7 +1354,7 @@ typedef union mxml_value_u mxml_value_t;
  • mxml_value_u
  • -

    mxml_value_u

    +

    mxml_value_u

    Description

    An XML node value.

    Definition

    diff --git a/mxmldoc.c b/mxmldoc.c index 2f3de71..8d2f46b 100644 --- a/mxmldoc.c +++ b/mxmldoc.c @@ -2289,8 +2289,8 @@ write_documentation( description = mxmlFindElement(scut, scut, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - cname, cname, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), cname, cname); if (description) { @@ -2474,8 +2474,8 @@ write_documentation( description = mxmlFindElement(scut, scut, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - name, name, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), name, name); if (description) { @@ -2540,8 +2540,8 @@ write_documentation( description = mxmlFindElement(function, function, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s() %s

    \n", - name, name, get_comment_info(description)); + "

    %s%s()

    \n", + get_comment_info(description), name, name); if (description) { @@ -2664,8 +2664,8 @@ write_documentation( description = mxmlFindElement(scut, scut, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - cname, cname, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), cname, cname); if (description) { @@ -2827,8 +2827,8 @@ write_documentation( description = mxmlFindElement(scut, scut, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - name, name, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), name, name); if (description) { @@ -2947,8 +2947,8 @@ write_documentation( description = mxmlFindElement(scut, scut, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - name, name, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), name, name); if (description) { @@ -3029,8 +3029,8 @@ write_documentation( description = mxmlFindElement(arg, arg, "description", NULL, NULL, MXML_DESCEND_FIRST); printf("\n" - "

    %s %s

    \n", - name, name, get_comment_info(description)); + "

    %s%s

    \n", + get_comment_info(description), name, name); if (description) {