Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html

changeset 5606
da305d172769
parent 4267
94496d77156b
--- a/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html	Sat Mar 11 19:17:59 2017 +0100
+++ b/Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html	Sat Mar 11 19:18:57 2017 +0100
@@ -308,16 +308,17 @@
 </dd>
 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
 <h4>ModuleDocument.__genListSection</h4>
-<b>__genListSection</b>(<i>names, dict, kwSuffix=""</i>)
+<b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>)
 <p>
         Private method to generate a list section of the document.
 </p><dl>
 <dt><i>names</i></dt>
 <dd>
 The names to appear in the list. (list of strings)
-</dd><dt><i>dict</i></dt>
+</dd><dt><i>sectionDict</i></dt>
 <dd>
-A dictionary containing all relevant information.
+dictionary containing all relevant information
+            (dict)
 </dd><dt><i>kwSuffix</i></dt>
 <dd>
 suffix to be used for the QtHelp keywords (string)
@@ -325,11 +326,11 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-The list section. (string)
+list section (string)
 </dd>
 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
 <h4>ModuleDocument.__genMethodSection</h4>
-<b>__genMethodSection</b>(<i>obj, className, filter</i>)
+<b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>)
 <p>
         Private method to generate the method details section.
 </p><dl>
@@ -339,7 +340,7 @@
 </dd><dt><i>className</i></dt>
 <dd>
 name of the class containing the method (string)
-</dd><dt><i>filter</i></dt>
+</dd><dt><i>modifierFilter</i></dt>
 <dd>
 filter value designating the method types
 </dd>
@@ -350,16 +351,17 @@
 </dd>
 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
 <h4>ModuleDocument.__genMethodsListSection</h4>
-<b>__genMethodsListSection</b>(<i>names, dict, className, clsName, includeInit=True</i>)
+<b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>)
 <p>
         Private method to generate the methods list section of a class.
 </p><dl>
 <dt><i>names</i></dt>
 <dd>
 names to appear in the list (list of strings)
-</dd><dt><i>dict</i></dt>
+</dd><dt><i>sectionDict</i></dt>
 <dd>
 dictionary containing all relevant information
+            (dict)
 </dd><dt><i>className</i></dt>
 <dd>
 class name containing the names
@@ -423,19 +425,20 @@
 </dd>
 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
 <h4>ModuleDocument.__genRbModulesClassesListSection</h4>
-<b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>)
+<b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>)
 <p>
         Private method to generate the classes list section of a Ruby module.
 </p><dl>
 <dt><i>names</i></dt>
 <dd>
 The names to appear in the list. (list of strings)
-</dd><dt><i>dict</i></dt>
+</dd><dt><i>sectionDict</i></dt>
 <dd>
-A dictionary containing all relevant information.
+dictionary containing all relevant information
+            (dict)
 </dd><dt><i>moduleName</i></dt>
 <dd>
-Name of the Ruby module containing the classes.
+name of the Ruby module containing the classes
             (string)
 </dd>
 </dl><dl>

eric ide

mercurial