Save work on adding @private@ comment support...

mxml-file.c:
    - Change comment from @private to @private@.

mxmldoc.c:
    - scan_file(): Changes to support @private@.
    - update_comment(): Remove node if the comment contains @private@.
This commit is contained in:
Michael R Sweet 2005-11-29 20:43:30 +00:00
parent 4e533e861b
commit 735989840c
4 changed files with 136 additions and 114 deletions

View File

@ -92,7 +92,7 @@
<h3><a name='mxmlAdd'>mxmlAdd()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Add a node to a tree.
<p>'mxmlAdd()' - Add a node to a tree.
Adds the specified node to the parent. If the child argument is not
NULL, puts the new node before or after the specified child depending
@ -124,7 +124,7 @@ mxmlAdd(
<h3><a name='mxmlDelete'>mxmlDelete()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Delete a node and all of its children.
<p>'mxmlDelete()' - Delete a node and all of its children.
If the specified node has a parent, this function first removes the
node from its parent using the mxmlRemove() function.</p>
@ -165,12 +165,12 @@ mxmlElementGetAttr(
<tr><td><tt>name</tt></td><td>Name of attribute</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Attribute value or NULL</p>
<p>O - Attribute value or NULL</p>
<!-- NEW PAGE -->
<h3><a name='mxmlElementSetAttr'>mxmlElementSetAttr()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Set an attribute.
<p>'mxmlElementSetAttr()' - Set an attribute.
If the named attribute already exists, the value of the attribute
is replaced by the new string value. The string value is copied
@ -207,7 +207,7 @@ mxmlEntityAddCallback(void);
<h4>Arguments</h4>
<p>None.</p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlEntityGetName'>mxmlEntityGetName()</a> </h3>
<hr noshade/>
@ -228,7 +228,7 @@ mxmlEntityGetName(
<tr><td><tt>val</tt></td><td>Character value</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Entity name or NULL</p>
<p>O - Entity name or NULL</p>
<!-- NEW PAGE -->
<h3><a name='mxmlEntityGetValue'>mxmlEntityGetValue()</a> </h3>
<hr noshade/>
@ -250,12 +250,12 @@ mxmlEntityGetValue(
<tr><td><tt>name</tt></td><td>Entity name</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Character value or -1 on error</p>
<p>O - Character value or -1 on error</p>
<!-- NEW PAGE -->
<h3><a name='mxmlEntityRemoveCallback'>mxmlEntityRemoveCallback()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Remove a callback.</p>
<p>'mxmlEntityRemoveCallback()' - Remove a callback.</p>
<h4>Syntax</h4>
<pre>
void
@ -302,12 +302,12 @@ mxmlFindElement(
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Element node or NULL</p>
<p>O - Element node or NULL</p>
<!-- NEW PAGE -->
<h3><a name='mxmlIndexDelete'>mxmlIndexDelete()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Delete an index.</p>
<p>'mxmlIndexDelete()' - Delete an index.</p>
<h4>Syntax</h4>
<pre>
void
@ -342,7 +342,7 @@ mxmlIndexEnum(
<tr><td><tt>ind</tt></td><td>Index to enumerate</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Next node or NULL if there is none</p>
<p>O - Next node or NULL if there is none</p>
<!-- NEW PAGE -->
<h3><a name='mxmlIndexFind'>mxmlIndexFind()</a> </h3>
<hr noshade/>
@ -370,7 +370,7 @@ mxmlIndexFind(
<tr><td><tt>value</tt></td><td>Attribute value, if any</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Node or NULL if none found</p>
<p>O - Node or NULL if none found</p>
<!-- NEW PAGE -->
<h3><a name='mxmlIndexNew'>mxmlIndexNew()</a> </h3>
<hr noshade/>
@ -399,7 +399,7 @@ mxmlIndexNew(
<tr><td><tt>attr</tt></td><td>Attribute to index or NULL for none</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New index</p>
<p>O - New index</p>
<!-- NEW PAGE -->
<h3><a name='mxmlIndexReset'>mxmlIndexReset()</a> </h3>
<hr noshade/>
@ -422,7 +422,7 @@ mxmlIndexReset(
<tr><td><tt>ind</tt></td><td>Index to reset</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>First node or NULL if there is none</p>
<p>O - First node or NULL if there is none</p>
<!-- NEW PAGE -->
<h3><a name='mxmlLoadFd'>mxmlLoadFd()</a> </h3>
<hr noshade/>
@ -454,7 +454,7 @@ mxmlLoadFd(
<tr><td><tt>fd</tt></td><td>File descriptor to read from</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>First node or NULL if the file could not be read.</p>
<p>O - First node or NULL if the file could not be read.</p>
<!-- NEW PAGE -->
<h3><a name='mxmlLoadFile'>mxmlLoadFile()</a> </h3>
<hr noshade/>
@ -486,7 +486,7 @@ mxmlLoadFile(
<tr><td><tt>fp</tt></td><td>File to read from</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>First node or NULL if the file could not be read.</p>
<p>O - First node or NULL if the file could not be read.</p>
<!-- NEW PAGE -->
<h3><a name='mxmlLoadString'>mxmlLoadString()</a> </h3>
<hr noshade/>
@ -518,7 +518,7 @@ mxmlLoadString(
<tr><td><tt>s</tt></td><td>String to load</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>First node or NULL if the string has errors.</p>
<p>O - First node or NULL if the string has errors.</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewCDATA'>mxmlNewCDATA()</a> <span class='info'>&nbsp;Mini-XML 2.3&nbsp;</span></h3>
<hr noshade/>
@ -546,7 +546,7 @@ mxmlNewCDATA(
<tr><td><tt>data</tt></td><td>Data string</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewCustom'>mxmlNewCustom()</a> <span class='info'>&nbsp;Mini-XML 2.1&nbsp;</span></h3>
<hr noshade/>
@ -574,7 +574,7 @@ mxmlNewCustom(
<tr><td><tt>data</tt></td><td>Pointer to data</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewElement'>mxmlNewElement()</a> </h3>
<hr noshade/>
@ -599,7 +599,7 @@ mxmlNewElement(
<tr><td><tt>name</tt></td><td>Name of element</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewInteger'>mxmlNewInteger()</a> </h3>
<hr noshade/>
@ -624,7 +624,7 @@ mxmlNewInteger(
<tr><td><tt>integer</tt></td><td>Integer value</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewOpaque'>mxmlNewOpaque()</a> </h3>
<hr noshade/>
@ -650,7 +650,7 @@ mxmlNewOpaque(
<tr><td><tt>opaque</tt></td><td>Opaque string</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewReal'>mxmlNewReal()</a> </h3>
<hr noshade/>
@ -675,7 +675,7 @@ mxmlNewReal(
<tr><td><tt>real</tt></td><td>Real number value</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewText'>mxmlNewText()</a> </h3>
<hr noshade/>
@ -704,7 +704,7 @@ mxmlNewText(
<tr><td><tt>string</tt></td><td>String</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlNewTextf'>mxmlNewTextf()</a> </h3>
<hr noshade/>
@ -735,12 +735,12 @@ mxmlNewTextf(
<tr><td><tt>...</tt></td><td>Additional args as needed</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>New node</p>
<p>O - New node</p>
<!-- NEW PAGE -->
<h3><a name='mxmlRemove'>mxmlRemove()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Remove a node from its parent.
<p>'mxmlRemove()' - Remove a node from its parent.
Does not free memory used by the node - use mxmlDelete() for that.
This function does nothing if the node has no parent.</p>
@ -788,7 +788,7 @@ mxmlSaveAllocString(
<tr><td><tt>node</tt></td><td>Node to write</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Allocated string or NULL</p>
<p>O - Allocated string or NULL</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSaveFd'>mxmlSaveFd()</a> </h3>
<hr noshade/>
@ -815,7 +815,7 @@ mxmlSaveFd(
<tr><td><tt>fd</tt></td><td>File descriptor to write to</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on error.</p>
<p>O - 0 on success, -1 on error.</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSaveFile'>mxmlSaveFile()</a> </h3>
<hr noshade/>
@ -842,7 +842,7 @@ mxmlSaveFile(
<tr><td><tt>fp</tt></td><td>File to write to</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on error.</p>
<p>O - 0 on success, -1 on error.</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSaveString'>mxmlSaveString()</a> </h3>
<hr noshade/>
@ -875,7 +875,7 @@ mxmlSaveString(
<tr><td><tt>bufsize</tt></td><td>Size of string buffer</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Size of string</p>
<p>O - Size of string</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetCDATA'>mxmlSetCDATA()</a> <span class='info'>&nbsp;Mini-XML 2.3&nbsp;</span></h3>
<hr noshade/>
@ -900,7 +900,7 @@ mxmlSetCDATA(
<tr><td><tt>data</tt></td><td>New data string</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetCustom'>mxmlSetCustom()</a> <span class='info'>&nbsp;Mini-XML 2.1&nbsp;</span></h3>
<hr noshade/>
@ -925,18 +925,19 @@ mxmlSetCustom(
<tr><td><tt>data</tt></td><td>New data pointer</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetCustomHandlers'>mxmlSetCustomHandlers()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Set the handling functions for custom data.
<p>'mxmlSetCustomHandlers()' - Set the handling functions for custom data.
The load function accepts a node pointer and a data string and must
return 0 on success and non-zero on error.
The save function accepts a node pointer and must return a malloc'd
string on success and NULL on error.</p>
string on success and NULL on error.
</p>
<h4>Syntax</h4>
<pre>
void
@ -975,12 +976,12 @@ mxmlSetElement(
<tr><td><tt>name</tt></td><td>New name string</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetErrorCallback'>mxmlSetErrorCallback()</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>Set the error message callback.</p>
<p>'mxmlSetErrorCallback()' - Set the error message callback.</p>
<h4>Syntax</h4>
<pre>
void
@ -1012,7 +1013,7 @@ mxmlSetInteger(
<tr><td><tt>integer</tt></td><td>Integer value</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetOpaque'>mxmlSetOpaque()</a> </h3>
<hr noshade/>
@ -1035,7 +1036,7 @@ mxmlSetOpaque(
<tr><td><tt>opaque</tt></td><td>Opaque string</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetReal'>mxmlSetReal()</a> </h3>
<hr noshade/>
@ -1058,7 +1059,7 @@ mxmlSetReal(
<tr><td><tt>real</tt></td><td>Real number value</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetText'>mxmlSetText()</a> </h3>
<hr noshade/>
@ -1083,7 +1084,7 @@ mxmlSetText(
<tr><td><tt>string</tt></td><td>String</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlSetTextf'>mxmlSetTextf()</a> </h3>
<hr noshade/>
@ -1110,7 +1111,7 @@ mxmlSetTextf(
<tr><td><tt>...</tt></td><td>Additional arguments as needed</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>0 on success, -1 on failure</p>
<p>O - 0 on success, -1 on failure</p>
<!-- NEW PAGE -->
<h3><a name='mxmlWalkNext'>mxmlWalkNext()</a> </h3>
<hr noshade/>
@ -1137,7 +1138,7 @@ mxmlWalkNext(
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Next node or NULL</p>
<p>O - Next node or NULL</p>
<!-- NEW PAGE -->
<h3><a name='mxmlWalkPrev'>mxmlWalkPrev()</a> </h3>
<hr noshade/>
@ -1164,7 +1165,7 @@ mxmlWalkPrev(
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
</tbody></table></p>
<h4>Returns</h4>
<p>Previous node or NULL</p>
<p>O - Previous node or NULL</p>
<!-- NEW PAGE -->
<h2><a name='_structures'>Structures</a></h2>
<ul>
@ -1179,7 +1180,7 @@ mxmlWalkPrev(
<h3><a name='mxml_attr_s'>mxml_attr_s</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML element attribute value.</p>
<p>Data types...</p>
<h4>Definition</h4>
<pre>
struct mxml_attr_s
@ -1328,7 +1329,7 @@ struct mxml_text_s
<h3><a name='mxml_attr_t'>mxml_attr_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML element attribute value.</p>
<p>Data types...</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_attr_s'>mxml_attr_s</a> mxml_attr_t;
@ -1355,7 +1356,7 @@ typedef char * (*mxml_custom_save_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *
<h3><a name='mxml_custom_t'>mxml_custom_t</a> <span class='info'>&nbsp;Mini-XML 2.1&nbsp;</span></h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML custom value. </p>
<p>*** An XML custom value. </p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_custom_s'>mxml_custom_s</a> mxml_custom_t;
@ -1364,7 +1365,7 @@ typedef struct <a href='#mxml_custom_s'>mxml_custom_s</a> mxml_custom_t;
<h3><a name='mxml_element_t'>mxml_element_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML element value.</p>
<p>*** An XML element value.</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_element_s'>mxml_element_s</a> mxml_element_t;
@ -1373,7 +1374,7 @@ typedef struct <a href='#mxml_element_s'>mxml_element_s</a> mxml_element_t;
<h3><a name='mxml_index_t'>mxml_index_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML node index.</p>
<p>*** An XML node index.</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_index_s'>mxml_index_s</a> mxml_index_t;
@ -1382,7 +1383,7 @@ typedef struct <a href='#mxml_index_s'>mxml_index_s</a> mxml_index_t;
<h3><a name='mxml_node_t'>mxml_node_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML node.</p>
<p>*** An XML node.</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_node_s'>mxml_node_s</a> mxml_node_t;
@ -1391,7 +1392,7 @@ typedef struct <a href='#mxml_node_s'>mxml_node_s</a> mxml_node_t;
<h3><a name='mxml_text_t'>mxml_text_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML text value.</p>
<p>*** An XML text value.</p>
<h4>Definition</h4>
<pre>
typedef struct <a href='#mxml_text_s'>mxml_text_s</a> mxml_text_t;
@ -1400,7 +1401,7 @@ typedef struct <a href='#mxml_text_s'>mxml_text_s</a> mxml_text_t;
<h3><a name='mxml_value_t'>mxml_value_t</a> </h3>
<hr noshade/>
<h4>Description</h4>
<p>An XML node value.</p>
<p>*** An XML node value.</p>
<h4>Definition</h4>
<pre>
typedef union <a href='#mxml_value_u'>mxml_value_u</a> mxml_value_t;

View File

@ -77,7 +77,7 @@
* Structures...
*/
typedef struct mxml_fdbuf_s /**** File descriptor buffer (@private) ****/
typedef struct mxml_fdbuf_s /**** File descriptor buffer (@private@) ****/
{
int fd; /* File descriptor */
unsigned char *current, /* Current position in buffer */

103
mxml.xml
View File

@ -3,7 +3,7 @@ xmlns="http://www.easysw.com"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.easysw.com/~mike/mxml/mxmldoc.xsd">
<function name="mxmlAdd">
<description>Add a node to a tree.
<description>'mxmlAdd()' - Add a node to a tree.
Adds the specified node to the parent. If the child argument is not
NULL, puts the new node before or after the specified child depending
@ -29,7 +29,7 @@ MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</description>
</argument>
</function>
<function name="mxmlDelete">
<description>Delete a node and all of its children.
<description>'mxmlDelete()' - Delete a node and all of its children.
If the specified node has a parent, this function first removes the
node from its parent using the mxmlRemove() function.</description>
@ -41,7 +41,7 @@ node from its parent using the mxmlRemove() function.</description>
<function name="mxmlElementGetAttr">
<returnvalue>
<type>const char *</type>
<description>Attribute value or NULL</description>
<description>O - Attribute value or NULL</description>
</returnvalue>
<description>Get an attribute.
@ -57,7 +57,7 @@ named attribute does not exist.</description>
</argument>
</function>
<function name="mxmlElementSetAttr">
<description>Set an attribute.
<description>'mxmlElementSetAttr()' - Set an attribute.
If the named attribute already exists, the value of the attribute
is replaced by the new string value. The string value is copied
@ -79,14 +79,14 @@ not an element.</description>
<function name="mxmlEntityAddCallback">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Add a callback to convert entities to Unicode.</description>
</function>
<function name="mxmlEntityGetName">
<returnvalue>
<type>const char *</type>
<description>Entity name or NULL</description>
<description>O - Entity name or NULL</description>
</returnvalue>
<description>Get the name that corresponds to the character value.
@ -99,7 +99,7 @@ If val does not need to be represented by a named entity, NULL is returned.</des
<function name="mxmlEntityGetValue">
<returnvalue>
<type>int</type>
<description>Character value or -1 on error</description>
<description>O - Character value or -1 on error</description>
</returnvalue>
<description>Get the character corresponding to a named entity.
@ -111,12 +111,12 @@ name is not known.</description>
</argument>
</function>
<function name="mxmlEntityRemoveCallback">
<description>Remove a callback.</description>
<description>'mxmlEntityRemoveCallback()' - Remove a callback.</description>
</function>
<function name="mxmlFindElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>Element node or NULL</description>
<description>O - Element node or NULL</description>
</returnvalue>
<description>Find the named element.
@ -154,7 +154,7 @@ constrains the search to a particular node's children.</description>
</argument>
</function>
<function name="mxmlIndexDelete">
<description>Delete an index.</description>
<description>'mxmlIndexDelete()' - Delete an index.</description>
<argument name="ind" direction="I">
<type>mxml_index_t *</type>
<description>Index to delete</description>
@ -163,7 +163,7 @@ constrains the search to a particular node's children.</description>
<function name="mxmlIndexEnum">
<returnvalue>
<type>mxml_node_t *</type>
<description>Next node or NULL if there is none</description>
<description>O - Next node or NULL if there is none</description>
</returnvalue>
<description>Return the next node in the index.
@ -176,7 +176,7 @@ Nodes are returned in the sorted order of the index.</description>
<function name="mxmlIndexFind">
<returnvalue>
<type>mxml_node_t *</type>
<description>Node or NULL if none found</description>
<description>O - Node or NULL if none found</description>
</returnvalue>
<description>Find the next matching node.
@ -200,7 +200,7 @@ to calling mxmlIndexEnum().</description>
<function name="mxmlIndexNew">
<returnvalue>
<type>mxml_index_t *</type>
<description>New index</description>
<description>O - New index</description>
</returnvalue>
<description>Create a new index.
@ -225,7 +225,7 @@ argument is not NULL.</description>
<function name="mxmlIndexReset">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if there is none</description>
<description>O - First node or NULL if there is none</description>
</returnvalue>
<description>Reset the enumeration/find pointer in the index and
return the first node in the index.
@ -240,7 +240,7 @@ mxmlIndexFind() for the first time.</description>
<function name="mxmlLoadFd">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
<description>O - First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file descriptor into an XML node tree.
@ -266,7 +266,7 @@ child nodes of the specified type.</description>
<function name="mxmlLoadFile">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the file could not be read.</description>
<description>O - First node or NULL if the file could not be read.</description>
</returnvalue>
<description>Load a file into an XML node tree.
@ -292,7 +292,7 @@ child nodes of the specified type.</description>
<function name="mxmlLoadString">
<returnvalue>
<type>mxml_node_t *</type>
<description>First node or NULL if the string has errors.</description>
<description>O - First node or NULL if the string has errors.</description>
</returnvalue>
<description>Load a string into an XML node tree.
@ -318,7 +318,7 @@ child nodes of the specified type.</description>
<function name="mxmlNewCDATA">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new CDATA node.
@ -340,7 +340,7 @@ is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
<function name="mxmlNewCustom">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new custom data node.
@ -362,7 +362,7 @@ node is not dynamically allocated or is separately managed.
<function name="mxmlNewElement">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new element node.
@ -381,7 +381,7 @@ element node has no parent.</description>
<function name="mxmlNewInteger">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new integer node.
@ -400,7 +400,7 @@ integer node has no parent.</description>
<function name="mxmlNewOpaque">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new opaque string.
@ -420,7 +420,7 @@ is copied into the new node.</description>
<function name="mxmlNewReal">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new real number node.
@ -439,7 +439,7 @@ the new real number node has no parent.</description>
<function name="mxmlNewText">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new text fragment node.
@ -464,7 +464,7 @@ string must be nul-terminated and is copied into the new node.</description>
<function name="mxmlNewTextf">
<returnvalue>
<type>mxml_node_t *</type>
<description>New node</description>
<description>O - New node</description>
</returnvalue>
<description>Create a new formatted text fragment node.
@ -490,7 +490,7 @@ string must be nul-terminated and is formatted into the new node.</description>
</argument>
</function>
<function name="mxmlRemove">
<description>Remove a node from its parent.
<description>'mxmlRemove()' - Remove a node from its parent.
Does not free memory used by the node - use mxmlDelete() for that.
This function does nothing if the node has no parent.</description>
@ -502,7 +502,7 @@ This function does nothing if the node has no parent.</description>
<function name="mxmlSaveAllocString">
<returnvalue>
<type>char *</type>
<description>Allocated string or NULL</description>
<description>O - Allocated string or NULL</description>
</returnvalue>
<description>Save an XML node tree to an allocated string.
@ -525,7 +525,7 @@ element tags.</description>
<function name="mxmlSaveFd">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on error.</description>
<description>O - 0 on success, -1 on error.</description>
</returnvalue>
<description>Save an XML tree to a file descriptor.
@ -546,7 +546,7 @@ element tags.</description>
<function name="mxmlSaveFile">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on error.</description>
<description>O - 0 on success, -1 on error.</description>
</returnvalue>
<description>Save an XML tree to a file.
@ -567,7 +567,7 @@ element tags.</description>
<function name="mxmlSaveString">
<returnvalue>
<type>int</type>
<description>Size of string</description>
<description>O - Size of string</description>
</returnvalue>
<description>Save an XML node tree to a string.
@ -596,7 +596,7 @@ element tags.</description>
<function name="mxmlSetCDATA">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the element name of a CDATA node.
@ -615,7 +615,7 @@ The node is not changed if it is not a CDATA element node.
<function name="mxmlSetCustom">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the data and destructor of a custom data node.
@ -632,13 +632,14 @@ The node is not changed if it is not a custom node.
</argument>
</function>
<function name="mxmlSetCustomHandlers">
<description>Set the handling functions for custom data.
<description>'mxmlSetCustomHandlers()' - Set the handling functions for custom data.
The load function accepts a node pointer and a data string and must
return 0 on success and non-zero on error.
The save function accepts a node pointer and must return a malloc'd
string on success and NULL on error.</description>
string on success and NULL on error.
</description>
<argument name="load" direction="I">
<type>mxml_custom_load_cb_t</type>
<description>Load function</description>
@ -651,7 +652,7 @@ string on success and NULL on error.</description>
<function name="mxmlSetElement">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the name of an element node.
@ -666,12 +667,12 @@ The node is not changed if it is not an element node.</description>
</argument>
</function>
<function name="mxmlSetErrorCallback">
<description>Set the error message callback.</description>
<description>'mxmlSetErrorCallback()' - Set the error message callback.</description>
</function>
<function name="mxmlSetInteger">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of an integer node.
@ -688,7 +689,7 @@ The node is not changed if it is not an integer node.</description>
<function name="mxmlSetOpaque">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of an opaque node.
@ -705,7 +706,7 @@ The node is not changed if it is not an opaque node.</description>
<function name="mxmlSetReal">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a real number node.
@ -722,7 +723,7 @@ The node is not changed if it is not a real number node.</description>
<function name="mxmlSetText">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a text node.
@ -743,7 +744,7 @@ The node is not changed if it is not a text node.</description>
<function name="mxmlSetTextf">
<returnvalue>
<type>int</type>
<description>0 on success, -1 on failure</description>
<description>O - 0 on success, -1 on failure</description>
</returnvalue>
<description>Set the value of a text node to a formatted string.
@ -767,7 +768,7 @@ The node is not changed if it is not a text node.</description>
<function name="mxmlWalkNext">
<returnvalue>
<type>mxml_node_t *</type>
<description>Next node or NULL</description>
<description>O - Next node or NULL</description>
</returnvalue>
<description>Walk to the next logical node in the tree.
@ -790,7 +791,7 @@ the node's children.</description>
<function name="mxmlWalkPrev">
<returnvalue>
<type>mxml_node_t *</type>
<description>Previous node or NULL</description>
<description>O - Previous node or NULL</description>
</returnvalue>
<description>Walk to the previous logical node in the tree.
@ -811,7 +812,7 @@ the walk to the node's children.</description>
</argument>
</function>
<struct name="mxml_attr_s">
<description>An XML element attribute value.</description>
<description>Data types...</description>
<variable name="name">
<type>char *</type>
<description>Attribute name</description>
@ -823,7 +824,7 @@ the walk to the node's children.</description>
</struct>
<typedef name="mxml_attr_t">
<type>struct mxml_attr_s</type>
<description>An XML element attribute value.</description>
<description>Data types...</description>
</typedef>
<typedef name="mxml_custom_load_cb_t">
<type>int(*)(mxml_node_t *, const char *)</type>
@ -844,7 +845,7 @@ the walk to the node's children.</description>
</typedef>
<typedef name="mxml_custom_t">
<type>struct mxml_custom_s</type>
<description>An XML custom value. @since Mini-XML 2.1@</description>
<description>*** An XML custom value. @since Mini-XML 2.1@</description>
</typedef>
<struct name="mxml_element_s">
<description>An XML element value.</description>
@ -863,7 +864,7 @@ the walk to the node's children.</description>
</struct>
<typedef name="mxml_element_t">
<type>struct mxml_element_s</type>
<description>An XML element value.</description>
<description>*** An XML element value.</description>
</typedef>
<struct name="mxml_index_s">
<description>An XML node index.</description>
@ -890,7 +891,7 @@ the walk to the node's children.</description>
</struct>
<typedef name="mxml_index_t">
<type>struct mxml_index_s</type>
<description>An XML node index.</description>
<description>*** An XML node index.</description>
</typedef>
<struct name="mxml_node_s">
<description>An XML node.</description>
@ -925,7 +926,7 @@ the walk to the node's children.</description>
</struct>
<typedef name="mxml_node_t">
<type>struct mxml_node_s</type>
<description>An XML node.</description>
<description>*** An XML node.</description>
</typedef>
<struct name="mxml_text_s">
<description>An XML text value.</description>
@ -940,7 +941,7 @@ the walk to the node's children.</description>
</struct>
<typedef name="mxml_text_t">
<type>struct mxml_text_s</type>
<description>An XML text value.</description>
<description>*** An XML text value.</description>
</typedef>
<enumeration name="mxml_type_e">
<description>The XML node type.</description>
@ -968,7 +969,7 @@ the walk to the node's children.</description>
</enumeration>
<typedef name="mxml_value_t">
<type>union mxml_value_u</type>
<description>An XML node value.</description>
<description>*** An XML node value.</description>
</typedef>
<union name="mxml_value_u">
<description>An XML node value.</description>

View File

@ -1,3 +1,4 @@
#define DEBUG 1
/*
* "$Id$"
*
@ -792,7 +793,7 @@ scan_file(const char *filename, /* I - Filename */
#endif /* DEBUG */
if (comment->last_child &&
strstr(comment->last_child->value.text.string, "@private"))
strstr(comment->last_child->value.text.string, "@private@"))
{
mxmlDelete(type);
type = NULL;
@ -861,9 +862,9 @@ scan_file(const char *filename, /* I - Filename */
#ifdef DEBUG
fputs(" duplicating comment for typedef...\n", stderr);
#endif /* DEBUG */
update_comment(typedefnode, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(typedefnode, comment->last_child);
}
description = mxmlNewElement(structclass, "description");
@ -871,9 +872,9 @@ scan_file(const char *filename, /* I - Filename */
fprintf(stderr, " adding comment to %s...\n",
structclass->value.element.name);
#endif /* DEBUG */
update_comment(structclass, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(structclass, comment->last_child);
if (scan_file(filename, fp, structclass))
{
@ -943,18 +944,18 @@ scan_file(const char *filename, /* I - Filename */
#ifdef DEBUG
fputs(" duplicating comment for typedef...\n", stderr);
#endif /* DEBUG */
update_comment(typedefnode, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(typedefnode, comment->last_child);
}
description = mxmlNewElement(enumeration, "description");
#ifdef DEBUG
fputs(" adding comment to enumeration...\n", stderr);
#endif /* DEBUG */
update_comment(enumeration, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(enumeration, comment->last_child);
}
else if (type && type->child &&
!strcmp(type->child->value.text.string, "extern"))
@ -1100,8 +1101,6 @@ scan_file(const char *filename, /* I - Filename */
mxmlDelete(type);
type = NULL;
}
typedefnode = NULL;
break;
case ':' :
@ -1224,8 +1223,11 @@ scan_file(const char *filename, /* I - Filename */
}
#ifdef DEBUG
fprintf(stderr, " processing comment, variable=%p, constant=%p, tree=\"%s\"\n",
variable, constant, tree->value.element.name);
fprintf(stderr,
" processing comment, variable=%p, "
"constant=%p, typedefnode=%p, tree=\"%s\"\n",
variable, constant, typedefnode,
tree->value.element.name);
#endif /* DEBUG */
if (variable)
@ -1325,6 +1327,14 @@ scan_file(const char *filename, /* I - Filename */
#endif /* DEBUG */
}
#ifdef DEBUG
fprintf(stderr,
" processing comment, variable=%p, "
"constant=%p, typedefnode=%p, tree=\"%s\"\n",
variable, constant, typedefnode,
tree->value.element.name);
#endif /* DEBUG */
if (variable)
{
description = mxmlNewElement(variable, "description");
@ -1630,9 +1640,9 @@ scan_file(const char *filename, /* I - Filename */
#ifdef DEBUG
fputs(" adding comment to returnvalue...\n", stderr);
#endif /* DEBUG */
update_comment(returnvalue, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(returnvalue, comment->last_child);
}
else
mxmlDelete(type);
@ -1641,9 +1651,9 @@ scan_file(const char *filename, /* I - Filename */
#ifdef DEBUG
fputs(" adding comment to function...\n", stderr);
#endif /* DEBUG */
update_comment(function, comment->last_child);
mxmlAdd(description, MXML_ADD_AFTER, MXML_ADD_TO_PARENT,
comment->last_child);
update_comment(function, comment->last_child);
type = NULL;
}
@ -2016,6 +2026,16 @@ update_comment(mxml_node_t *parent, /* I - Parent node */
for (; ptr > comment->value.text.string && isspace(*ptr & 255); ptr --)
*ptr = '\0';
/*
* Remove private types, variables, etc.
*/
if (strstr(comment->value.text.string, "@private@"))
{
fputs("Deleting private node!\n", stderr);
mxmlDelete(parent);
}
#ifdef DEBUG
fprintf(stderr, " updated comment = %s\n", comment->value.text.string);
#endif /* DEBUG */