Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html
src/eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html
- branch
- eric7
- changeset 10418
- 4573827e9815
- parent 9209
- b99e7fd55fd3
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10417:c6011e501282 | 10418:4573827e9815 |
|---|---|
| 208 Private method to check, if the object to be documented contains a | 208 Private method to check, if the object to be documented contains a |
| 209 deprecated flag. | 209 deprecated flag. |
| 210 </p> | 210 </p> |
| 211 <dl> | 211 <dl> |
| 212 | 212 |
| 213 <dt><i>descr</i></dt> | 213 <dt><i>descr</i> (str)</dt> |
| 214 <dd> | 214 <dd> |
| 215 documentation string (string) | 215 documentation string |
| 216 </dd> | 216 </dd> |
| 217 </dl> | 217 </dl> |
| 218 <dl> | 218 <dl> |
| 219 <dt>Return:</dt> | 219 <dt>Return:</dt> |
| 220 <dd> | 220 <dd> |
| 221 flag indicating the deprecation status (boolean) | 221 flag indicating the deprecation status |
| 222 </dd> | |
| 223 </dl> | |
| 224 <dl> | |
| 225 <dt>Return Type:</dt> | |
| 226 <dd> | |
| 227 bool | |
| 222 </dd> | 228 </dd> |
| 223 </dl> | 229 </dl> |
| 224 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> | 230 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> |
| 225 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> | 231 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> |
| 226 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) | 232 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) |
| 231 <p> | 237 <p> |
| 232 This cross reference entry looks like "package.module#member label". | 238 This cross reference entry looks like "package.module#member label". |
| 233 </p> | 239 </p> |
| 234 <dl> | 240 <dl> |
| 235 | 241 |
| 236 <dt><i>entry</i></dt> | 242 <dt><i>entry</i> (str)</dt> |
| 237 <dd> | 243 <dd> |
| 238 the entry to be formatted (string) | 244 entry to be formatted |
| 239 </dd> | 245 </dd> |
| 240 </dl> | 246 </dl> |
| 241 <dl> | 247 <dl> |
| 242 <dt>Return:</dt> | 248 <dt>Return:</dt> |
| 243 <dd> | 249 <dd> |
| 244 formatted entry (string) | 250 formatted entry |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Return Type:</dt> | |
| 255 <dd> | |
| 256 str | |
| 245 </dd> | 257 </dd> |
| 246 </dl> | 258 </dl> |
| 247 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> | 259 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a> |
| 248 <h4>ModuleDocument.__formatDescription</h4> | 260 <h4>ModuleDocument.__formatDescription</h4> |
| 249 <b>__formatDescription</b>(<i>descr</i>) | 261 <b>__formatDescription</b>(<i>descr</i>) |
| 251 <p> | 263 <p> |
| 252 Private method to format the contents of the documentation string. | 264 Private method to format the contents of the documentation string. |
| 253 </p> | 265 </p> |
| 254 <dl> | 266 <dl> |
| 255 | 267 |
| 256 <dt><i>descr</i></dt> | 268 <dt><i>descr</i> (str)</dt> |
| 257 <dd> | 269 <dd> |
| 258 The contents of the documentation string. (string) | 270 contents of the documentation string |
| 259 </dd> | 271 </dd> |
| 260 </dl> | 272 </dl> |
| 261 <dl> | 273 <dl> |
| 262 <dt>Return:</dt> | 274 <dt>Return:</dt> |
| 263 <dd> | 275 <dd> |
| 264 The formatted contents of the documentation string. (string) | 276 formatted contents of the documentation string |
| 277 </dd> | |
| 278 </dl> | |
| 279 <dl> | |
| 280 <dt>Return Type:</dt> | |
| 281 <dd> | |
| 282 str | |
| 265 </dd> | 283 </dd> |
| 266 </dl> | 284 </dl> |
| 267 <dl> | 285 <dl> |
| 268 | 286 |
| 269 <dt>Raises <b>TagError</b>:</dt> | 287 <dt>Raises <b>TagError</b>:</dt> |
| 270 <dd> | 288 <dd> |
| 271 A tag doesn't have the correct number | 289 A tag doesn't have the correct number of arguments. |
| 272 of arguments. | |
| 273 </dd> | 290 </dd> |
| 274 </dl> | 291 </dl> |
| 275 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> | 292 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a> |
| 276 <h4>ModuleDocument.__genClassListSection</h4> | 293 <h4>ModuleDocument.__genClassListSection</h4> |
| 277 <b>__genClassListSection</b>(<i></i>) | 294 <b>__genClassListSection</b>(<i></i>) |
| 281 module. | 298 module. |
| 282 </p> | 299 </p> |
| 283 <dl> | 300 <dl> |
| 284 <dt>Return:</dt> | 301 <dt>Return:</dt> |
| 285 <dd> | 302 <dd> |
| 286 The classes list section. (string) | 303 classes list section |
| 304 </dd> | |
| 305 </dl> | |
| 306 <dl> | |
| 307 <dt>Return Type:</dt> | |
| 308 <dd> | |
| 309 str | |
| 287 </dd> | 310 </dd> |
| 288 </dl> | 311 </dl> |
| 289 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> | 312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a> |
| 290 <h4>ModuleDocument.__genClassesSection</h4> | 313 <h4>ModuleDocument.__genClassesSection</h4> |
| 291 <b>__genClassesSection</b>(<i></i>) | 314 <b>__genClassesSection</b>(<i></i>) |
| 295 classes. | 318 classes. |
| 296 </p> | 319 </p> |
| 297 <dl> | 320 <dl> |
| 298 <dt>Return:</dt> | 321 <dt>Return:</dt> |
| 299 <dd> | 322 <dd> |
| 300 The classes details section. (string) | 323 classes details section |
| 324 </dd> | |
| 325 </dl> | |
| 326 <dl> | |
| 327 <dt>Return Type:</dt> | |
| 328 <dd> | |
| 329 str | |
| 301 </dd> | 330 </dd> |
| 302 </dl> | 331 </dl> |
| 303 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> | 332 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a> |
| 304 <h4>ModuleDocument.__genDescriptionListSection</h4> | 333 <h4>ModuleDocument.__genDescriptionListSection</h4> |
| 305 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) | 334 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>) |
| 307 <p> | 336 <p> |
| 308 Private method to generate the list section of a description. | 337 Private method to generate the list section of a description. |
| 309 </p> | 338 </p> |
| 310 <dl> | 339 <dl> |
| 311 | 340 |
| 312 <dt><i>dictionary</i></dt> | 341 <dt><i>dictionary</i> (dict)</dt> |
| 313 <dd> | 342 <dd> |
| 314 Dictionary containing the info for the | 343 dictionary containing the info for the |
| 315 list section. | 344 list section |
| 316 </dd> | 345 </dd> |
| 317 <dt><i>template</i></dt> | 346 <dt><i>template</i> (str)</dt> |
| 318 <dd> | 347 <dd> |
| 319 The template to be used for the list. (string) | 348 template to be used for the list |
| 320 </dd> | 349 </dd> |
| 321 </dl> | 350 </dl> |
| 322 <dl> | 351 <dl> |
| 323 <dt>Return:</dt> | 352 <dt>Return:</dt> |
| 324 <dd> | 353 <dd> |
| 325 The list section. (string) | 354 list section |
| 355 </dd> | |
| 356 </dl> | |
| 357 <dl> | |
| 358 <dt>Return Type:</dt> | |
| 359 <dd> | |
| 360 str | |
| 326 </dd> | 361 </dd> |
| 327 </dl> | 362 </dl> |
| 328 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> | 363 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a> |
| 329 <h4>ModuleDocument.__genFunctionListSection</h4> | 364 <h4>ModuleDocument.__genFunctionListSection</h4> |
| 330 <b>__genFunctionListSection</b>(<i></i>) | 365 <b>__genFunctionListSection</b>(<i></i>) |
| 334 module. | 369 module. |
| 335 </p> | 370 </p> |
| 336 <dl> | 371 <dl> |
| 337 <dt>Return:</dt> | 372 <dt>Return:</dt> |
| 338 <dd> | 373 <dd> |
| 339 The functions list section. (string) | 374 functions list section |
| 375 </dd> | |
| 376 </dl> | |
| 377 <dl> | |
| 378 <dt>Return Type:</dt> | |
| 379 <dd> | |
| 380 str | |
| 340 </dd> | 381 </dd> |
| 341 </dl> | 382 </dl> |
| 342 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> | 383 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a> |
| 343 <h4>ModuleDocument.__genFunctionsSection</h4> | 384 <h4>ModuleDocument.__genFunctionsSection</h4> |
| 344 <b>__genFunctionsSection</b>(<i></i>) | 385 <b>__genFunctionsSection</b>(<i></i>) |
| 348 functions. | 389 functions. |
| 349 </p> | 390 </p> |
| 350 <dl> | 391 <dl> |
| 351 <dt>Return:</dt> | 392 <dt>Return:</dt> |
| 352 <dd> | 393 <dd> |
| 353 The functions details section. (string) | 394 functions details section |
| 395 </dd> | |
| 396 </dl> | |
| 397 <dl> | |
| 398 <dt>Return Type:</dt> | |
| 399 <dd> | |
| 400 str | |
| 354 </dd> | 401 </dd> |
| 355 </dl> | 402 </dl> |
| 356 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> | 403 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> |
| 357 <h4>ModuleDocument.__genGlobalsListSection</h4> | 404 <h4>ModuleDocument.__genGlobalsListSection</h4> |
| 358 <b>__genGlobalsListSection</b>(<i>class_=None</i>) | 405 <b>__genGlobalsListSection</b>(<i>class_=None</i>) |
| 361 Private method to generate the section listing all global attributes of | 408 Private method to generate the section listing all global attributes of |
| 362 the module. | 409 the module. |
| 363 </p> | 410 </p> |
| 364 <dl> | 411 <dl> |
| 365 | 412 |
| 366 <dt><i>class_</i></dt> | 413 <dt><i>class_</i> (class)</dt> |
| 367 <dd> | 414 <dd> |
| 368 reference to a class object (Class) | 415 reference to a class object |
| 369 </dd> | 416 </dd> |
| 370 </dl> | 417 </dl> |
| 371 <dl> | 418 <dl> |
| 372 <dt>Return:</dt> | 419 <dt>Return:</dt> |
| 373 <dd> | 420 <dd> |
| 374 The globals list section. (string) | 421 globals list section |
| 422 </dd> | |
| 423 </dl> | |
| 424 <dl> | |
| 425 <dt>Return Type:</dt> | |
| 426 <dd> | |
| 427 str | |
| 375 </dd> | 428 </dd> |
| 376 </dl> | 429 </dl> |
| 377 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> | 430 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
| 378 <h4>ModuleDocument.__genListSection</h4> | 431 <h4>ModuleDocument.__genListSection</h4> |
| 379 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) | 432 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>) |
| 381 <p> | 434 <p> |
| 382 Private method to generate a list section of the document. | 435 Private method to generate a list section of the document. |
| 383 </p> | 436 </p> |
| 384 <dl> | 437 <dl> |
| 385 | 438 |
| 386 <dt><i>names</i></dt> | 439 <dt><i>names</i> (list of str)</dt> |
| 387 <dd> | 440 <dd> |
| 388 The names to appear in the list. (list of strings) | 441 names to appear in the list |
| 389 </dd> | 442 </dd> |
| 390 <dt><i>sectionDict</i></dt> | 443 <dt><i>sectionDict</i> (dict)</dt> |
| 391 <dd> | 444 <dd> |
| 392 dictionary containing all relevant information | 445 dictionary containing all relevant information |
| 393 (dict) | 446 </dd> |
| 394 </dd> | 447 <dt><i>kwSuffix</i> (str)</dt> |
| 395 <dt><i>kwSuffix</i></dt> | 448 <dd> |
| 396 <dd> | 449 suffix to be used for the QtHelp keywords |
| 397 suffix to be used for the QtHelp keywords (string) | 450 </dd> |
| 398 </dd> | 451 </dl> |
| 399 </dl> | 452 <dl> |
| 400 <dl> | 453 <dt>Return:</dt> |
| 401 <dt>Return:</dt> | 454 <dd> |
| 402 <dd> | 455 list section |
| 403 list section (string) | 456 </dd> |
| 457 </dl> | |
| 458 <dl> | |
| 459 <dt>Return Type:</dt> | |
| 460 <dd> | |
| 461 str | |
| 404 </dd> | 462 </dd> |
| 405 </dl> | 463 </dl> |
| 406 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> | 464 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
| 407 <h4>ModuleDocument.__genMethodSection</h4> | 465 <h4>ModuleDocument.__genMethodSection</h4> |
| 408 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) | 466 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>) |
| 410 <p> | 468 <p> |
| 411 Private method to generate the method details section. | 469 Private method to generate the method details section. |
| 412 </p> | 470 </p> |
| 413 <dl> | 471 <dl> |
| 414 | 472 |
| 415 <dt><i>obj</i></dt> | 473 <dt><i>obj</i> (class)</dt> |
| 416 <dd> | 474 <dd> |
| 417 reference to the object being formatted | 475 reference to the object being formatted |
| 418 </dd> | 476 </dd> |
| 419 <dt><i>className</i></dt> | 477 <dt><i>className</i> (str)</dt> |
| 420 <dd> | 478 <dd> |
| 421 name of the class containing the method (string) | 479 name of the class containing the method |
| 422 </dd> | 480 </dd> |
| 423 <dt><i>modifierFilter</i></dt> | 481 <dt><i>modifierFilter</i> (str)</dt> |
| 424 <dd> | 482 <dd> |
| 425 filter value designating the method types | 483 filter value designating the method types |
| 426 </dd> | 484 </dd> |
| 427 </dl> | 485 </dl> |
| 428 <dl> | 486 <dl> |
| 429 <dt>Return:</dt> | 487 <dt>Return:</dt> |
| 430 <dd> | 488 <dd> |
| 431 method list and method details section (tuple of two string) | 489 method list and method details section |
| 490 </dd> | |
| 491 </dl> | |
| 492 <dl> | |
| 493 <dt>Return Type:</dt> | |
| 494 <dd> | |
| 495 tuple of (str, str) | |
| 432 </dd> | 496 </dd> |
| 433 </dl> | 497 </dl> |
| 434 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> | 498 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
| 435 <h4>ModuleDocument.__genMethodsListSection</h4> | 499 <h4>ModuleDocument.__genMethodsListSection</h4> |
| 436 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) | 500 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>) |
| 438 <p> | 502 <p> |
| 439 Private method to generate the methods list section of a class. | 503 Private method to generate the methods list section of a class. |
| 440 </p> | 504 </p> |
| 441 <dl> | 505 <dl> |
| 442 | 506 |
| 443 <dt><i>names</i></dt> | 507 <dt><i>names</i> (list of str)</dt> |
| 444 <dd> | 508 <dd> |
| 445 names to appear in the list (list of strings) | 509 names to appear in the list |
| 446 </dd> | 510 </dd> |
| 447 <dt><i>sectionDict</i></dt> | 511 <dt><i>sectionDict</i> (dict)</dt> |
| 448 <dd> | 512 <dd> |
| 449 dictionary containing all relevant information | 513 dictionary containing all relevant information |
| 450 (dict) | 514 </dd> |
| 451 </dd> | 515 <dt><i>className</i> (str)</dt> |
| 452 <dt><i>className</i></dt> | |
| 453 <dd> | 516 <dd> |
| 454 class name containing the names | 517 class name containing the names |
| 455 </dd> | 518 </dd> |
| 456 <dt><i>clsName</i></dt> | 519 <dt><i>clsName</i> (str)</dt> |
| 457 <dd> | 520 <dd> |
| 458 visible class name containing the names | 521 visible class name containing the names |
| 459 </dd> | 522 </dd> |
| 460 <dt><i>includeInit</i></dt> | 523 <dt><i>includeInit</i> (bool)</dt> |
| 461 <dd> | 524 <dd> |
| 462 flag indicating to include the __init__ method | 525 flag indicating to include the __init__ method |
| 463 (boolean) | 526 </dd> |
| 464 </dd> | 527 </dl> |
| 465 </dl> | 528 <dl> |
| 466 <dl> | 529 <dt>Return:</dt> |
| 467 <dt>Return:</dt> | 530 <dd> |
| 468 <dd> | 531 methods list section |
| 469 methods list section (string) | 532 </dd> |
| 533 </dl> | |
| 534 <dl> | |
| 535 <dt>Return Type:</dt> | |
| 536 <dd> | |
| 537 str | |
| 470 </dd> | 538 </dd> |
| 471 </dl> | 539 </dl> |
| 472 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> | 540 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> |
| 473 <h4>ModuleDocument.__genModuleSection</h4> | 541 <h4>ModuleDocument.__genModuleSection</h4> |
| 474 <b>__genModuleSection</b>(<i></i>) | 542 <b>__genModuleSection</b>(<i></i>) |
| 477 Private method to generate the body of the document. | 545 Private method to generate the body of the document. |
| 478 </p> | 546 </p> |
| 479 <dl> | 547 <dl> |
| 480 <dt>Return:</dt> | 548 <dt>Return:</dt> |
| 481 <dd> | 549 <dd> |
| 482 The body of the document. (string) | 550 body of the document |
| 551 </dd> | |
| 552 </dl> | |
| 553 <dl> | |
| 554 <dt>Return Type:</dt> | |
| 555 <dd> | |
| 556 str | |
| 483 </dd> | 557 </dd> |
| 484 </dl> | 558 </dl> |
| 485 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> | 559 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a> |
| 486 <h4>ModuleDocument.__genParagraphs</h4> | 560 <h4>ModuleDocument.__genParagraphs</h4> |
| 487 <b>__genParagraphs</b>(<i>lines</i>) | 561 <b>__genParagraphs</b>(<i>lines</i>) |
| 494 an intermediate empty line. Empty lines are treated as a paragraph | 568 an intermediate empty line. Empty lines are treated as a paragraph |
| 495 delimiter. | 569 delimiter. |
| 496 </p> | 570 </p> |
| 497 <dl> | 571 <dl> |
| 498 | 572 |
| 499 <dt><i>lines</i></dt> | 573 <dt><i>lines</i> (list of str)</dt> |
| 500 <dd> | 574 <dd> |
| 501 A list of individual lines. (list of strings) | 575 list of individual lines |
| 502 </dd> | 576 </dd> |
| 503 </dl> | 577 </dl> |
| 504 <dl> | 578 <dl> |
| 505 <dt>Return:</dt> | 579 <dt>Return:</dt> |
| 506 <dd> | 580 <dd> |
| 507 Ready formatted paragraphs. (string) | 581 formatted paragraphs |
| 582 </dd> | |
| 583 </dl> | |
| 584 <dl> | |
| 585 <dt>Return Type:</dt> | |
| 586 <dd> | |
| 587 str | |
| 508 </dd> | 588 </dd> |
| 509 </dl> | 589 </dl> |
| 510 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> | 590 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a> |
| 511 <h4>ModuleDocument.__genParamDescriptionListSection</h4> | 591 <h4>ModuleDocument.__genParamDescriptionListSection</h4> |
| 512 <b>__genParamDescriptionListSection</b>(<i>_list</i>) | 592 <b>__genParamDescriptionListSection</b>(<i>_list</i>) |
| 514 <p> | 594 <p> |
| 515 Private method to generate the list section of a description. | 595 Private method to generate the list section of a description. |
| 516 </p> | 596 </p> |
| 517 <dl> | 597 <dl> |
| 518 | 598 |
| 519 <dt><i>_list</i></dt> | 599 <dt><i>_list</i> (list of lists with three elements)</dt> |
| 520 <dd> | 600 <dd> |
| 521 list containing the info for the parameter description | 601 list containing the info for the parameter description |
| 522 list section (list of lists with three elements) | 602 list section |
| 523 </dd> | 603 </dd> |
| 524 </dl> | 604 </dl> |
| 525 <dl> | 605 <dl> |
| 526 <dt>Return:</dt> | 606 <dt>Return:</dt> |
| 527 <dd> | 607 <dd> |
| 528 formatted list section (string) | 608 formatted list section |
| 609 </dd> | |
| 610 </dl> | |
| 611 <dl> | |
| 612 <dt>Return Type:</dt> | |
| 613 <dd> | |
| 614 str | |
| 529 </dd> | 615 </dd> |
| 530 </dl> | 616 </dl> |
| 531 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> | 617 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a> |
| 532 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> | 618 <h4>ModuleDocument.__genRbModulesClassesListSection</h4> |
| 533 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) | 619 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>) |
| 535 <p> | 621 <p> |
| 536 Private method to generate the classes list section of a Ruby module. | 622 Private method to generate the classes list section of a Ruby module. |
| 537 </p> | 623 </p> |
| 538 <dl> | 624 <dl> |
| 539 | 625 |
| 540 <dt><i>names</i></dt> | 626 <dt><i>names</i> (list of str)</dt> |
| 541 <dd> | 627 <dd> |
| 542 The names to appear in the list. (list of strings) | 628 names to appear in the list |
| 543 </dd> | 629 </dd> |
| 544 <dt><i>sectionDict</i></dt> | 630 <dt><i>sectionDict</i> (dict)</dt> |
| 545 <dd> | 631 <dd> |
| 546 dictionary containing all relevant information | 632 dictionary containing all relevant information |
| 547 (dict) | 633 </dd> |
| 548 </dd> | 634 <dt><i>moduleName</i> (str)</dt> |
| 549 <dt><i>moduleName</i></dt> | |
| 550 <dd> | 635 <dd> |
| 551 name of the Ruby module containing the classes | 636 name of the Ruby module containing the classes |
| 552 (string) | 637 </dd> |
| 553 </dd> | 638 </dl> |
| 554 </dl> | 639 <dl> |
| 555 <dl> | 640 <dt>Return:</dt> |
| 556 <dt>Return:</dt> | 641 <dd> |
| 557 <dd> | 642 list section |
| 558 The list section. (string) | 643 </dd> |
| 644 </dl> | |
| 645 <dl> | |
| 646 <dt>Return Type:</dt> | |
| 647 <dd> | |
| 648 str | |
| 559 </dd> | 649 </dd> |
| 560 </dl> | 650 </dl> |
| 561 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> | 651 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a> |
| 562 <h4>ModuleDocument.__genRbModulesClassesSection</h4> | 652 <h4>ModuleDocument.__genRbModulesClassesSection</h4> |
| 563 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) | 653 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>) |
| 565 <p> | 655 <p> |
| 566 Private method to generate the Ruby module classes details section. | 656 Private method to generate the Ruby module classes details section. |
| 567 </p> | 657 </p> |
| 568 <dl> | 658 <dl> |
| 569 | 659 |
| 570 <dt><i>obj</i></dt> | 660 <dt><i>obj</i> (class)</dt> |
| 571 <dd> | 661 <dd> |
| 572 Reference to the object being formatted. | 662 reference to the object being formatted |
| 573 </dd> | 663 </dd> |
| 574 <dt><i>modName</i></dt> | 664 <dt><i>modName</i> (str)</dt> |
| 575 <dd> | 665 <dd> |
| 576 Name of the Ruby module containing the classes. (string) | 666 name of the Ruby module containing the classes |
| 577 </dd> | 667 </dd> |
| 578 </dl> | 668 </dl> |
| 579 <dl> | 669 <dl> |
| 580 <dt>Return:</dt> | 670 <dt>Return:</dt> |
| 581 <dd> | 671 <dd> |
| 582 The classes list and classes details section. | 672 classes list and classes details section |
| 583 (tuple of two string) | 673 </dd> |
| 674 </dl> | |
| 675 <dl> | |
| 676 <dt>Return Type:</dt> | |
| 677 <dd> | |
| 678 tuple of (str, str) | |
| 584 </dd> | 679 </dd> |
| 585 </dl> | 680 </dl> |
| 586 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> | 681 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> |
| 587 <h4>ModuleDocument.__genRbModulesListSection</h4> | 682 <h4>ModuleDocument.__genRbModulesListSection</h4> |
| 588 <b>__genRbModulesListSection</b>(<i></i>) | 683 <b>__genRbModulesListSection</b>(<i></i>) |
| 592 (Ruby only). | 687 (Ruby only). |
| 593 </p> | 688 </p> |
| 594 <dl> | 689 <dl> |
| 595 <dt>Return:</dt> | 690 <dt>Return:</dt> |
| 596 <dd> | 691 <dd> |
| 597 The modules list section. (string) | 692 modules list section |
| 693 </dd> | |
| 694 </dl> | |
| 695 <dl> | |
| 696 <dt>Return Type:</dt> | |
| 697 <dd> | |
| 698 str | |
| 598 </dd> | 699 </dd> |
| 599 </dl> | 700 </dl> |
| 600 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> | 701 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a> |
| 601 <h4>ModuleDocument.__genRbModulesSection</h4> | 702 <h4>ModuleDocument.__genRbModulesSection</h4> |
| 602 <b>__genRbModulesSection</b>(<i></i>) | 703 <b>__genRbModulesSection</b>(<i></i>) |
| 606 Ruby modules. | 707 Ruby modules. |
| 607 </p> | 708 </p> |
| 608 <dl> | 709 <dl> |
| 609 <dt>Return:</dt> | 710 <dt>Return:</dt> |
| 610 <dd> | 711 <dd> |
| 611 The Ruby modules details section. (string) | 712 Ruby modules details section |
| 713 </dd> | |
| 714 </dl> | |
| 715 <dl> | |
| 716 <dt>Return Type:</dt> | |
| 717 <dd> | |
| 718 str | |
| 612 </dd> | 719 </dd> |
| 613 </dl> | 720 </dl> |
| 614 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> | 721 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a> |
| 615 <h4>ModuleDocument.__genSeeListSection</h4> | 722 <h4>ModuleDocument.__genSeeListSection</h4> |
| 616 <b>__genSeeListSection</b>(<i>_list, template</i>) | 723 <b>__genSeeListSection</b>(<i>_list, template</i>) |
| 619 Private method to generate the "see also" list section of a | 726 Private method to generate the "see also" list section of a |
| 620 description. | 727 description. |
| 621 </p> | 728 </p> |
| 622 <dl> | 729 <dl> |
| 623 | 730 |
| 624 <dt><i>_list</i></dt> | 731 <dt><i>_list</i> (list)</dt> |
| 625 <dd> | 732 <dd> |
| 626 List containing the info for the section. | 733 list containing the info for the section |
| 627 </dd> | 734 </dd> |
| 628 <dt><i>template</i></dt> | 735 <dt><i>template</i> (str)</dt> |
| 629 <dd> | 736 <dd> |
| 630 The template to be used for the list. (string) | 737 template to be used for the list |
| 631 </dd> | 738 </dd> |
| 632 </dl> | 739 </dl> |
| 633 <dl> | 740 <dl> |
| 634 <dt>Return:</dt> | 741 <dt>Return:</dt> |
| 635 <dd> | 742 <dd> |
| 636 The list section. (string) | 743 list section |
| 744 </dd> | |
| 745 </dl> | |
| 746 <dl> | |
| 747 <dt>Return Type:</dt> | |
| 748 <dd> | |
| 749 str | |
| 637 </dd> | 750 </dd> |
| 638 </dl> | 751 </dl> |
| 639 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> | 752 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a> |
| 640 <h4>ModuleDocument.__getShortDescription</h4> | 753 <h4>ModuleDocument.__getShortDescription</h4> |
| 641 <b>__getShortDescription</b>(<i>desc</i>) | 754 <b>__getShortDescription</b>(<i>desc</i>) |
| 647 The short description is just the first non empty line of the | 760 The short description is just the first non empty line of the |
| 648 documentation string. | 761 documentation string. |
| 649 </p> | 762 </p> |
| 650 <dl> | 763 <dl> |
| 651 | 764 |
| 652 <dt><i>desc</i></dt> | 765 <dt><i>desc</i> (str)</dt> |
| 653 <dd> | 766 <dd> |
| 654 The documentation string. (string) | 767 documentation string |
| 655 </dd> | 768 </dd> |
| 656 </dl> | 769 </dl> |
| 657 <dl> | 770 <dl> |
| 658 <dt>Return:</dt> | 771 <dt>Return:</dt> |
| 659 <dd> | 772 <dd> |
| 660 The short description. (string) | 773 short description |
| 774 </dd> | |
| 775 </dl> | |
| 776 <dl> | |
| 777 <dt>Return Type:</dt> | |
| 778 <dd> | |
| 779 str | |
| 661 </dd> | 780 </dd> |
| 662 </dl> | 781 </dl> |
| 663 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> | 782 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a> |
| 664 <h4>ModuleDocument.__processInlineTags</h4> | 783 <h4>ModuleDocument.__processInlineTags</h4> |
| 665 <b>__processInlineTags</b>(<i>desc</i>) | 784 <b>__processInlineTags</b>(<i>desc</i>) |
| 667 <p> | 786 <p> |
| 668 Private method to process inline tags. | 787 Private method to process inline tags. |
| 669 </p> | 788 </p> |
| 670 <dl> | 789 <dl> |
| 671 | 790 |
| 672 <dt><i>desc</i></dt> | 791 <dt><i>desc</i> (str)</dt> |
| 673 <dd> | 792 <dd> |
| 674 One line of the description (string) | 793 one line of the description |
| 675 </dd> | 794 </dd> |
| 676 </dl> | 795 </dl> |
| 677 <dl> | 796 <dl> |
| 678 <dt>Return:</dt> | 797 <dt>Return:</dt> |
| 679 <dd> | 798 <dd> |
| 680 processed line with inline tags expanded (string) | 799 processed line with inline tags expanded |
| 800 </dd> | |
| 801 </dl> | |
| 802 <dl> | |
| 803 <dt>Return Type:</dt> | |
| 804 <dd> | |
| 805 str | |
| 681 </dd> | 806 </dd> |
| 682 </dl> | 807 </dl> |
| 683 <dl> | 808 <dl> |
| 684 | 809 |
| 685 <dt>Raises <b>TagError</b>:</dt> | 810 <dt>Raises <b>TagError</b>:</dt> |
| 695 Public method used to get the description of the module. | 820 Public method used to get the description of the module. |
| 696 </p> | 821 </p> |
| 697 <dl> | 822 <dl> |
| 698 <dt>Return:</dt> | 823 <dt>Return:</dt> |
| 699 <dd> | 824 <dd> |
| 700 The description of the module. (string) | 825 description of the module |
| 826 </dd> | |
| 827 </dl> | |
| 828 <dl> | |
| 829 <dt>Return Type:</dt> | |
| 830 <dd> | |
| 831 str | |
| 701 </dd> | 832 </dd> |
| 702 </dl> | 833 </dl> |
| 703 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> | 834 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a> |
| 704 <h4>ModuleDocument.genDocument</h4> | 835 <h4>ModuleDocument.genDocument</h4> |
| 705 <b>genDocument</b>(<i></i>) | 836 <b>genDocument</b>(<i></i>) |
| 708 Public method to generate the source code documentation. | 839 Public method to generate the source code documentation. |
| 709 </p> | 840 </p> |
| 710 <dl> | 841 <dl> |
| 711 <dt>Return:</dt> | 842 <dt>Return:</dt> |
| 712 <dd> | 843 <dd> |
| 713 The source code documentation. (string) | 844 source code documentation |
| 845 </dd> | |
| 846 </dl> | |
| 847 <dl> | |
| 848 <dt>Return Type:</dt> | |
| 849 <dd> | |
| 850 str | |
| 714 </dd> | 851 </dd> |
| 715 </dl> | 852 </dl> |
| 716 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> | 853 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a> |
| 717 <h4>ModuleDocument.getQtHelpKeywords</h4> | 854 <h4>ModuleDocument.getQtHelpKeywords</h4> |
| 718 <b>getQtHelpKeywords</b>(<i></i>) | 855 <b>getQtHelpKeywords</b>(<i></i>) |
| 721 Public method to retrieve the parts for the QtHelp keywords section. | 858 Public method to retrieve the parts for the QtHelp keywords section. |
| 722 </p> | 859 </p> |
| 723 <dl> | 860 <dl> |
| 724 <dt>Return:</dt> | 861 <dt>Return:</dt> |
| 725 <dd> | 862 <dd> |
| 726 list of tuples containing the name (string) and the ref | 863 list of tuples containing the name and the ref. The ref is without |
| 727 (string). The ref is without the filename part. | 864 the filename part. |
| 865 </dd> | |
| 866 </dl> | |
| 867 <dl> | |
| 868 <dt>Return Type:</dt> | |
| 869 <dd> | |
| 870 list of tuples of (str, str) | |
| 728 </dd> | 871 </dd> |
| 729 </dl> | 872 </dl> |
| 730 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> | 873 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a> |
| 731 <h4>ModuleDocument.isEmpty</h4> | 874 <h4>ModuleDocument.isEmpty</h4> |
| 732 <b>isEmpty</b>(<i></i>) | 875 <b>isEmpty</b>(<i></i>) |
| 736 functions. | 879 functions. |
| 737 </p> | 880 </p> |
| 738 <dl> | 881 <dl> |
| 739 <dt>Return:</dt> | 882 <dt>Return:</dt> |
| 740 <dd> | 883 <dd> |
| 741 Flag indicating an empty module (i.e. __init__.py without | 884 flag indicating an empty module (i.e. __init__.py without |
| 742 any contents) | 885 any contents) |
| 886 </dd> | |
| 887 </dl> | |
| 888 <dl> | |
| 889 <dt>Return Type:</dt> | |
| 890 <dd> | |
| 891 bool | |
| 743 </dd> | 892 </dd> |
| 744 </dl> | 893 </dl> |
| 745 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> | 894 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a> |
| 746 <h4>ModuleDocument.name</h4> | 895 <h4>ModuleDocument.name</h4> |
| 747 <b>name</b>(<i></i>) | 896 <b>name</b>(<i></i>) |
| 750 Public method used to get the module name. | 899 Public method used to get the module name. |
| 751 </p> | 900 </p> |
| 752 <dl> | 901 <dl> |
| 753 <dt>Return:</dt> | 902 <dt>Return:</dt> |
| 754 <dd> | 903 <dd> |
| 755 The name of the module. (string) | 904 name of the module |
| 905 </dd> | |
| 906 </dl> | |
| 907 <dl> | |
| 908 <dt>Return Type:</dt> | |
| 909 <dd> | |
| 910 str | |
| 756 </dd> | 911 </dd> |
| 757 </dl> | 912 </dl> |
| 758 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> | 913 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a> |
| 759 <h4>ModuleDocument.shortDescription</h4> | 914 <h4>ModuleDocument.shortDescription</h4> |
| 760 <b>shortDescription</b>(<i></i>) | 915 <b>shortDescription</b>(<i></i>) |
| 767 description. | 922 description. |
| 768 </p> | 923 </p> |
| 769 <dl> | 924 <dl> |
| 770 <dt>Return:</dt> | 925 <dt>Return:</dt> |
| 771 <dd> | 926 <dd> |
| 772 The short description of the module. (string) | 927 short description of the module |
| 928 </dd> | |
| 929 </dl> | |
| 930 <dl> | |
| 931 <dt>Return Type:</dt> | |
| 932 <dd> | |
| 933 str | |
| 773 </dd> | 934 </dd> |
| 774 </dl> | 935 </dl> |
| 775 <div align="right"><a href="#top">Up</a></div> | 936 <div align="right"><a href="#top">Up</a></div> |
| 776 <hr /> | 937 <hr /> |
| 777 <hr /> | 938 <hr /> |
