Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html
Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html
- changeset 5606
- da305d172769
- parent 4267
- 94496d77156b
equal
deleted
inserted
replaced
| 5605:1950fe1a32c4 | 5606:da305d172769 |
|---|---|
| 306 <dd> | 306 <dd> |
| 307 The globals list section. (string) | 307 The globals list section. (string) |
| 308 </dd> | 308 </dd> |
| 309 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> | 309 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
| 310 <h4>ModuleDocument.__genListSection</h4> | 310 <h4>ModuleDocument.__genListSection</h4> |
| 311 <b>__genListSection</b>(<i>names, dict, kwSuffix=""</i>) | 311 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) |
| 312 <p> | 312 <p> |
| 313 Private method to generate a list section of the document. | 313 Private method to generate a list section of the document. |
| 314 </p><dl> | 314 </p><dl> |
| 315 <dt><i>names</i></dt> | 315 <dt><i>names</i></dt> |
| 316 <dd> | 316 <dd> |
| 317 The names to appear in the list. (list of strings) | 317 The names to appear in the list. (list of strings) |
| 318 </dd><dt><i>dict</i></dt> | 318 </dd><dt><i>sectionDict</i></dt> |
| 319 <dd> | 319 <dd> |
| 320 A dictionary containing all relevant information. | 320 dictionary containing all relevant information |
| 321 (dict) | |
| 321 </dd><dt><i>kwSuffix</i></dt> | 322 </dd><dt><i>kwSuffix</i></dt> |
| 322 <dd> | 323 <dd> |
| 323 suffix to be used for the QtHelp keywords (string) | 324 suffix to be used for the QtHelp keywords (string) |
| 324 </dd> | 325 </dd> |
| 325 </dl><dl> | 326 </dl><dl> |
| 326 <dt>Returns:</dt> | 327 <dt>Returns:</dt> |
| 327 <dd> | 328 <dd> |
| 328 The list section. (string) | 329 list section (string) |
| 329 </dd> | 330 </dd> |
| 330 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> | 331 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
| 331 <h4>ModuleDocument.__genMethodSection</h4> | 332 <h4>ModuleDocument.__genMethodSection</h4> |
| 332 <b>__genMethodSection</b>(<i>obj, className, filter</i>) | 333 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) |
| 333 <p> | 334 <p> |
| 334 Private method to generate the method details section. | 335 Private method to generate the method details section. |
| 335 </p><dl> | 336 </p><dl> |
| 336 <dt><i>obj</i></dt> | 337 <dt><i>obj</i></dt> |
| 337 <dd> | 338 <dd> |
| 338 reference to the object being formatted | 339 reference to the object being formatted |
| 339 </dd><dt><i>className</i></dt> | 340 </dd><dt><i>className</i></dt> |
| 340 <dd> | 341 <dd> |
| 341 name of the class containing the method (string) | 342 name of the class containing the method (string) |
| 342 </dd><dt><i>filter</i></dt> | 343 </dd><dt><i>modifierFilter</i></dt> |
| 343 <dd> | 344 <dd> |
| 344 filter value designating the method types | 345 filter value designating the method types |
| 345 </dd> | 346 </dd> |
| 346 </dl><dl> | 347 </dl><dl> |
| 347 <dt>Returns:</dt> | 348 <dt>Returns:</dt> |
| 348 <dd> | 349 <dd> |
| 349 method list and method details section (tuple of two string) | 350 method list and method details section (tuple of two string) |
| 350 </dd> | 351 </dd> |
| 351 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> | 352 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
| 352 <h4>ModuleDocument.__genMethodsListSection</h4> | 353 <h4>ModuleDocument.__genMethodsListSection</h4> |
| 353 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName, includeInit=True</i>) | 354 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) |
| 354 <p> | 355 <p> |
| 355 Private method to generate the methods list section of a class. | 356 Private method to generate the methods list section of a class. |
| 356 </p><dl> | 357 </p><dl> |
| 357 <dt><i>names</i></dt> | 358 <dt><i>names</i></dt> |
| 358 <dd> | 359 <dd> |
| 359 names to appear in the list (list of strings) | 360 names to appear in the list (list of strings) |
| 360 </dd><dt><i>dict</i></dt> | 361 </dd><dt><i>sectionDict</i></dt> |
| 361 <dd> | 362 <dd> |
| 362 dictionary containing all relevant information | 363 dictionary containing all relevant information |
| 364 (dict) | |
| 363 </dd><dt><i>className</i></dt> | 365 </dd><dt><i>className</i></dt> |
| 364 <dd> | 366 <dd> |
| 365 class name containing the names | 367 class name containing the names |
| 366 </dd><dt><i>clsName</i></dt> | 368 </dd><dt><i>clsName</i></dt> |
| 367 <dd> | 369 <dd> |
| 421 <dd> | 423 <dd> |
| 422 formatted list section (string) | 424 formatted list section (string) |
| 423 </dd> | 425 </dd> |
| 424 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> | 426 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> |
| 425 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> | 427 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> |
| 426 <b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>) | 428 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) |
| 427 <p> | 429 <p> |
| 428 Private method to generate the classes list section of a Ruby module. | 430 Private method to generate the classes list section of a Ruby module. |
| 429 </p><dl> | 431 </p><dl> |
| 430 <dt><i>names</i></dt> | 432 <dt><i>names</i></dt> |
| 431 <dd> | 433 <dd> |
| 432 The names to appear in the list. (list of strings) | 434 The names to appear in the list. (list of strings) |
| 433 </dd><dt><i>dict</i></dt> | 435 </dd><dt><i>sectionDict</i></dt> |
| 434 <dd> | 436 <dd> |
| 435 A dictionary containing all relevant information. | 437 dictionary containing all relevant information |
| 438 (dict) | |
| 436 </dd><dt><i>moduleName</i></dt> | 439 </dd><dt><i>moduleName</i></dt> |
| 437 <dd> | 440 <dd> |
| 438 Name of the Ruby module containing the classes. | 441 name of the Ruby module containing the classes |
| 439 (string) | 442 (string) |
| 440 </dd> | 443 </dd> |
| 441 </dl><dl> | 444 </dl><dl> |
| 442 <dt>Returns:</dt> | 445 <dt>Returns:</dt> |
| 443 <dd> | 446 <dd> |
