--- a/Documentation/Source/eric5.E5XML.XMLWriterBase.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5XML.XMLWriterBase.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5XML.XMLWriterBase</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#111;&#102; &#101;&#114;&#105;&#99;&#53;&#115; &#88;&#77;&#76; w&#114;&#105;&#116;&#101;&#114;&#115;.
+Module implementing a base class for all of eric5s XML writers.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#XMLWriterBase">XMLWriterBase</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#111;&#102; &#101;&#114;&#105;&#99;&#53;&#115; &#88;&#77;&#76; w&#114;&#105;&#116;&#101;&#114;&#115;.</td>
+<td>Class implementing a base class for all of eric5s XML writers.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="XMLWriterBase" ID="XMLWriterBase"></a>
 <h2>XMLWriterBase</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#111;&#102; &#101;&#114;&#105;&#99;&#53;&#115; &#88;&#77;&#76; w&#114;&#105;&#116;&#101;&#114;&#115;.
+    Class implementing a base class for all of eric5s XML writers.
 </p>
 <h3>Derived from</h3>
 object
@@ -55,317 +55,317 @@
 <table>
 <tr>
 <td><a href="#XMLWriterBase.__init__">XMLWriterBase</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write">_write</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#100;&#111; &#116;&#104;&#101; &#114;&#101;&#97;&#108; w&#114;&#105;&#116;&#101; &#111;&#112;&#101;&#114;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Protected method used to do the real write operation.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._writeBasics">_writeBasics</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#111;&#102; &#97; &#98;&#97;&#115;&#105;&#99; &#80;y&#116;&#104;&#111;&#110; &#116;y&#112;&#101;.</td>
+<td>Protected method to dump an object of a basic Python type.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_bool">_write_bool</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;&#111;&#111;&#108; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a bool object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_bytearray">_write_bytearray</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;y&#116;&#101;&#97;&#114;&#114;&#97;y &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a bytearray object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_bytes">_write_bytes</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;y&#116;&#101;&#115; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a bytes object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_complex">_write_complex</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#99;&#111;&#109;&#112;&#108;&#101;x &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a complex object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_dictionary">_write_dictionary</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#100;&#105;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a dict object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_float">_write_float</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#102;&#108;&#111;&#97;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a float object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_frozenset">_write_frozenset</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#102;&#114;&#111;z&#101;&#110;&#115;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a frozenset object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_int">_write_int</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97;&#110; &#105;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump an int object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_list">_write_list</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#108;&#105;&#115;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a list object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_none">_write_none</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#78;&#111;&#110;&#101;&#84;y&#112;&#101; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a NoneType object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_set">_write_set</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#115;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a set object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_string">_write_string</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#115;&#116;&#114; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a str object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_tuple">_write_tuple</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#116;&#117;&#112;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Protected method to dump a tuple object.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase._write_unimplemented">_write_unimplemented</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#116;y&#112;&#101;, &#116;&#104;&#97;&#116; &#104;&#97;&#115; &#110;&#111; &#115;&#112;&#101;&#99;&#105;&#97;&#108; &#109;&#101;&#116;&#104;&#111;&#100;.</td>
+<td>Protected method to dump a type, that has no special method.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase.encodedNewLines">encodedNewLines</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;&#110;&#99;&#111;&#100;&#101; &#110;&#101;w&#108;&#105;&#110;&#101;&#115; &#97;&#110;&#100; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104; &#98;&#114;&#101;&#97;&#107;&#115;.</td>
+<td>Public method to encode newlines and paragraph breaks.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase.escape">escape</a></td>
-<td>&#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#101;&#115;&#99;&#97;&#112;&#101; &, &#60;, &#97;&#110;&#100; &#62; &#105;&#110; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#111;&#102; &#100;&#97;&#116;&#97;.</td>
+<td>Function to escape &, <, and > in a string of data.</td>
 </tr><tr>
 <td><a href="#XMLWriterBase.writeXML">writeXML</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#104;&#101; &#88;&#77;&#76; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to write the XML to the file.</td>
 </tr>
 </table>
 <a NAME="XMLWriterBase.__init__" ID="XMLWriterBase.__init__"></a>
 <h4>XMLWriterBase (Constructor)</h4>
 <b>XMLWriterBase</b>(<i>file</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>file</i></dt>
 <dd>
-&#111;&#112;&#101;&#110; &#102;&#105;&#108;&#101; (&#108;&#105;&#107;&#101;) &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; w&#114;&#105;&#116;&#105;&#110;&#103;
+open file (like) object for writing
 </dd>
 </dl><a NAME="XMLWriterBase._write" ID="XMLWriterBase._write"></a>
 <h4>XMLWriterBase._write</h4>
 <b>_write</b>(<i>s, newline = True</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#117;&#115;&#101;&#100; &#116;&#111; &#100;&#111; &#116;&#104;&#101; &#114;&#101;&#97;&#108; w&#114;&#105;&#116;&#101; &#111;&#112;&#101;&#114;&#97;&#116;&#105;&#111;&#110;.
+        Protected method used to do the real write operation.
 </p><dl>
 <dt><i>s</i></dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; &#116;&#111; &#116;&#104;&#101; &#88;&#77;&#76; &#102;&#105;&#108;&#101;
+string to be written to the XML file
 </dd><dt><i>newline</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#108;&#105;&#110;&#101;&#98;&#114;&#101;&#97;&#107;
+flag indicating a linebreak
 </dd>
 </dl><a NAME="XMLWriterBase._writeBasics" ID="XMLWriterBase._writeBasics"></a>
 <h4>XMLWriterBase._writeBasics</h4>
 <b>_writeBasics</b>(<i>pyobject, indent = 0</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#111;&#102; &#97; &#98;&#97;&#115;&#105;&#99; &#80;y&#116;&#104;&#111;&#110; &#116;y&#112;&#101;.
+        Protected method to dump an object of a basic Python type.
 </p><dl>
 <dt><i>pyobject</i></dt>
 <dd>
-&#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100;
+object to be dumped
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_bool" ID="XMLWriterBase._write_bool"></a>
 <h4>XMLWriterBase._write_bool</h4>
 <b>_write_bool</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;&#111;&#111;&#108; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a bool object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+value to be dumped (boolean)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_bytearray" ID="XMLWriterBase._write_bytearray"></a>
 <h4>XMLWriterBase._write_bytearray</h4>
 <b>_write_bytearray</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;y&#116;&#101;&#97;&#114;&#114;&#97;y &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a bytearray object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#98;y&#116;&#101;&#97;&#114;&#114;&#97;y)
+value to be dumped (bytearray)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_bytes" ID="XMLWriterBase._write_bytes"></a>
 <h4>XMLWriterBase._write_bytes</h4>
 <b>_write_bytes</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#98;y&#116;&#101;&#115; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a bytes object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#98;y&#116;&#101;&#115;)
+value to be dumped (bytes)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_complex" ID="XMLWriterBase._write_complex"></a>
 <h4>XMLWriterBase._write_complex</h4>
 <b>_write_complex</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#99;&#111;&#109;&#112;&#108;&#101;x &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a complex object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#99;&#111;&#109;&#112;&#108;&#101;x)
+value to be dumped (complex)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_dictionary" ID="XMLWriterBase._write_dictionary"></a>
 <h4>XMLWriterBase._write_dictionary</h4>
 <b>_write_dictionary</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#100;&#105;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a dict object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y)
+value to be dumped (dictionary)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_float" ID="XMLWriterBase._write_float"></a>
 <h4>XMLWriterBase._write_float</h4>
 <b>_write_float</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#102;&#108;&#111;&#97;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a float object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#102;&#108;&#111;&#97;&#116;)
+value to be dumped (float)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_frozenset" ID="XMLWriterBase._write_frozenset"></a>
 <h4>XMLWriterBase._write_frozenset</h4>
 <b>_write_frozenset</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#102;&#114;&#111;z&#101;&#110;&#115;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a frozenset object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#102;&#114;&#111;z&#101;&#110;&#115;&#101;&#116;)
+value to be dumped (frozenset)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_int" ID="XMLWriterBase._write_int"></a>
 <h4>XMLWriterBase._write_int</h4>
 <b>_write_int</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97;&#110; &#105;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump an int object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+value to be dumped (integer)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_list" ID="XMLWriterBase._write_list"></a>
 <h4>XMLWriterBase._write_list</h4>
 <b>_write_list</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#108;&#105;&#115;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a list object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#108;&#105;&#115;&#116;)
+value to be dumped (list)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_none" ID="XMLWriterBase._write_none"></a>
 <h4>XMLWriterBase._write_none</h4>
 <b>_write_none</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#78;&#111;&#110;&#101;&#84;y&#112;&#101; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a NoneType object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#78;&#111;&#110;&#101;) (&#105;&#103;&#110;&#111;&#114;&#101;&#100;)
+value to be dumped (None) (ignored)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_set" ID="XMLWriterBase._write_set"></a>
 <h4>XMLWriterBase._write_set</h4>
 <b>_write_set</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#115;&#101;&#116; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a set object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#115;&#101;&#116;)
+value to be dumped (set)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_string" ID="XMLWriterBase._write_string"></a>
 <h4>XMLWriterBase._write_string</h4>
 <b>_write_string</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#115;&#116;&#114; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a str object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+value to be dumped (string)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_tuple" ID="XMLWriterBase._write_tuple"></a>
 <h4>XMLWriterBase._write_tuple</h4>
 <b>_write_tuple</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#116;&#117;&#112;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Protected method to dump a tuple object.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#116;&#117;&#112;&#108;&#101;)
+value to be dumped (tuple)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase._write_unimplemented" ID="XMLWriterBase._write_unimplemented"></a>
 <h4>XMLWriterBase._write_unimplemented</h4>
 <b>_write_unimplemented</b>(<i>value, indent</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#117;&#109;&#112; &#97; &#116;y&#112;&#101;, &#116;&#104;&#97;&#116; &#104;&#97;&#115; &#110;&#111; &#115;&#112;&#101;&#99;&#105;&#97;&#108; &#109;&#101;&#116;&#104;&#111;&#100;.
+        Protected method to dump a type, that has no special method.
 </p><dl>
 <dt><i>value</i></dt>
 <dd>
-v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#100;&#117;&#109;&#112;&#101;&#100; (&#97;&#110;y &#112;&#105;&#99;&#107;&#108;&#101;&#97;&#98;&#108;&#101; &#111;&#98;&#106;&#101;&#99;&#116;)
+value to be dumped (any pickleable object)
 </dd><dt><i>indent</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#108;&#101;v&#101;&#108; &#102;&#111;&#114; &#112;&#114;&#101;&#116;&#116;&#105;&#101;&#114; &#111;&#117;&#116;&#112;&#117;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+indentation level for prettier output (integer)
 </dd>
 </dl><a NAME="XMLWriterBase.encodedNewLines" ID="XMLWriterBase.encodedNewLines"></a>
 <h4>XMLWriterBase.encodedNewLines</h4>
 <b>encodedNewLines</b>(<i>text</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#101;&#110;&#99;&#111;&#100;&#101; &#110;&#101;w&#108;&#105;&#110;&#101;&#115; &#97;&#110;&#100; &#112;&#97;&#114;&#97;&#103;&#114;&#97;&#112;&#104; &#98;&#114;&#101;&#97;&#107;&#115;.
+        Public method to encode newlines and paragraph breaks.
 </p><dl>
 <dt><i>text</i></dt>
 <dd>
-&#116;&#101;x&#116; &#116;&#111; &#101;&#110;&#99;&#111;&#100;&#101; (&#115;&#116;&#114;&#105;&#110;&#103; &#111;&#114; &#81;&#83;&#116;&#114;&#105;&#110;&#103;)
+text to encode (string or QString)
 </dd>
 </dl><a NAME="XMLWriterBase.escape" ID="XMLWriterBase.escape"></a>
 <h4>XMLWriterBase.escape</h4>
 <b>escape</b>(<i>data, attribute=False</i>)
 <p>
-        &#70;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#101;&#115;&#99;&#97;&#112;&#101; &, &#60;, &#97;&#110;&#100; &#62; &#105;&#110; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#111;&#102; &#100;&#97;&#116;&#97;.
+        Function to escape &, <, and > in a string of data.
 </p><dl>
 <dt><i>data</i></dt>
 <dd>
-&#100;&#97;&#116;&#97; &#116;&#111; &#98;&#101; &#101;&#115;&#99;&#97;&#112;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+data to be escaped (string)
 </dd><dt><i>attribute</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#101;&#115;&#99;&#97;&#112;&#105;&#110;&#103; &#105;&#115; &#100;&#111;&#110;&#101; &#102;&#111;&#114; &#97;&#110; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;
+flag indicating escaping is done for an attribute
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#101;&#115;&#99;&#97;&#112;&#101;&#100; &#100;&#97;&#116;&#97; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the escaped data (string)
 </dd>
 </dl><a NAME="XMLWriterBase.writeXML" ID="XMLWriterBase.writeXML"></a>
 <h4>XMLWriterBase.writeXML</h4>
 <b>writeXML</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#104;&#101; &#88;&#77;&#76; &#116;&#111; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
+        Public method to write the XML to the file.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />