Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html

changeset 2966
f85f686981ad
parent 2387
2d119e79ab54
child 3018
70924c0bdaf1
diff -r d133c7edd88a -r f85f686981ad Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
--- a/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html	Sun Sep 29 18:22:08 2013 +0200
+++ b/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html	Sun Sep 29 18:23:27 2013 +0200
@@ -180,14 +180,14 @@
         Private method to check, if the object to be documented contains a
         deprecated flag.
 </p><dl>
-<dt><i>desc</i></dt>
+<dt><i>descr</i></dt>
 <dd>
-The documentation string. (string)
+documentation string (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-Flag indicating the deprecation status. (boolean)
+flag indicating the deprecation status (boolean)
 </dd>
 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
 <h4>ModuleDocument.__formatCrossReferenceEntry</h4>
@@ -530,6 +530,11 @@
 <dd>
 processed line with inline tags expanded (string)
 </dd>
+</dl><dl>
+<dt>Raises <b>TagError</b>:</dt>
+<dd>
+raised to indicate an invalid tag
+</dd>
 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
 <h4>ModuleDocument.description</h4>
 <b>description</b>(<i></i>)

eric ide

mercurial