Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html

changeset 3018
70924c0bdaf1
parent 2966
f85f686981ad
--- a/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html	Sun Oct 13 17:29:57 2013 +0200
+++ b/Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html	Sun Oct 13 17:44:48 2013 +0200
@@ -231,7 +231,8 @@
 <h4>ModuleDocument.__genClassListSection</h4>
 <b>__genClassListSection</b>(<i></i>)
 <p>
-        Private method to generate the section listing all classes of the module.
+        Private method to generate the section listing all classes of the
+        module.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -241,7 +242,8 @@
 <h4>ModuleDocument.__genClassesSection</h4>
 <b>__genClassesSection</b>(<i></i>)
 <p>
-        Private method to generate the document section with details about classes.
+        Private method to generate the document section with details about
+        classes.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -270,7 +272,8 @@
 <h4>ModuleDocument.__genFunctionListSection</h4>
 <b>__genFunctionListSection</b>(<i></i>)
 <p>
-        Private method to generate the section listing all functions of the module.
+        Private method to generate the section listing all functions of the
+        module.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -280,7 +283,8 @@
 <h4>ModuleDocument.__genFunctionsSection</h4>
 <b>__genFunctionsSection</b>(<i></i>)
 <p>
-        Private method to generate the document section with details about functions.
+        Private method to generate the document section with details about
+        functions.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -364,7 +368,8 @@
 visible class name containing the names
 </dd><dt><i>includeInit</i></dt>
 <dd>
-flag indicating to include the __init__ method (boolean)
+flag indicating to include the __init__ method
+            (boolean)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -433,7 +438,8 @@
 A dictionary containing all relevant information.
 </dd><dt><i>moduleName</i></dt>
 <dd>
-Name of the Ruby module containing the classes. (string)
+Name of the Ruby module containing the classes.
+            (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -456,7 +462,8 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-The classes list and classes details section. (tuple of two string)
+The classes list and classes details section.
+            (tuple of two string)
 </dd>
 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
 <h4>ModuleDocument.__genRbModulesListSection</h4>
@@ -473,7 +480,8 @@
 <h4>ModuleDocument.__genRbModulesSection</h4>
 <b>__genRbModulesSection</b>(<i></i>)
 <p>
-        Private method to generate the document section with details about Ruby modules.
+        Private method to generate the document section with details about
+        Ruby modules.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
@@ -483,7 +491,8 @@
 <h4>ModuleDocument.__genSeeListSection</h4>
 <b>__genSeeListSection</b>(<i>_list, template</i>)
 <p>
-        Private method to generate the "see also" list section of a description.
+        Private method to generate the "see also" list section of a
+        description.
 </p><dl>
 <dt><i>_list</i></dt>
 <dd>
@@ -563,14 +572,15 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of tuples containing the name (string) and the ref (string). The ref
-            is without the filename part.
+list of tuples containing the name (string) and the ref
+            (string). The ref is without the filename part.
 </dd>
 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
 <h4>ModuleDocument.isEmpty</h4>
 <b>isEmpty</b>(<i></i>)
 <p>
-        Public method to determine, if the module contains any classes or functions.
+        Public method to determine, if the module contains any classes or
+        functions.
 </p><dl>
 <dt>Returns:</dt>
 <dd>

eric ide

mercurial