|
459 | 459 | # ====== <tt>:nodoc:</tt> |
460 | 460 | # |
461 | 461 | # - Appended to a line of code |
462 | | -# that defines a class, module, method, alias, constant, or attribute. |
| 462 | +# that defines a class, module, method, alias, constant, or attribute; |
| 463 | +# takes optional argument +all+ (<tt>:nodoc: all</tt>). |
463 | 464 | # - Specifies that the defined object should not be documented. |
464 | 465 | # |
465 | 466 | # For a method definition in C code, it the directive must be in the comment line |
|
485 | 486 | # For a constant definition in C code, this directive <em>can not work</em> |
486 | 487 | # because there is no "implementation" place for a constant. |
487 | 488 | # |
488 | | -# With argument +all+: |
| 489 | +# With argument +all+ (<tt>:nodoc: all</tt>), |
489 | 490 | # specifies that the class or module should not be documented. |
490 | 491 | # By default, however, a nested class or module _will_ be documented. |
491 | 492 | # |
|
528 | 529 | # |
529 | 530 | # ====== <tt>:markup:</tt> |
530 | 531 | # |
531 | | -# - Appears on a line by itself. |
532 | | -# - Takes argument +format+. |
| 532 | +# - Appears on a line by itself; takes argument +format+ (<tt>:markup: _format_</tt>). |
533 | 533 | # - Specifies the format for the \RDoc input; |
534 | 534 | # argument +format+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. |
535 | 535 | # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats]. |
|
555 | 555 | # |
556 | 556 | # ====== <tt>:args:</tt> |
557 | 557 | # |
558 | | -# - Appears on a line by itself. |
559 | | -# - Takes argument +arg_names+. |
| 558 | +# - Appears on a line by itself; takes argument +arg_names+ (<tt>:args: _arg_names_</tt>). |
560 | 559 | # - Specifies the arguments to be reported in the HTML, |
561 | 560 | # overriding the actual arguments in the code. |
562 | 561 | # See method #args_directive. |
|
565 | 564 | # |
566 | 565 | # ====== <tt>:yields:</tt> |
567 | 566 | # |
568 | | -# - Appears on a line by itself. |
569 | | -# - Takes argument +arg_names+. |
| 567 | +# - Appears on a line by itself; takes argument +arg_names+ (<tt>:yields: _arg_names_</tt>). |
570 | 568 | # - Specifies the yield arguments to be reported in the HTML, |
571 | 569 | # overriding the actual yield in the code. |
572 | 570 | # See method #yields_directive. |
|
585 | 583 | # |
586 | 584 | # ====== <tt>:section:</tt> |
587 | 585 | # |
588 | | -# - Appears on a line by itself. |
589 | | -# - Takes argument +section_title+. |
| 586 | +# - Appears on a line by itself; takes argument +section_title+ (<tt>:section: _section_title_</tt>). |
590 | 587 | # - Specifies that following methods are to be grouped into the section |
591 | | -# with the given <em>section_title</em>, |
| 588 | +# with the given +section_title+, |
592 | 589 | # or into the default section if no title is given. |
593 | 590 | # The directive remains in effect until another such directive is given, |
594 | 591 | # but may be temporarily overridden by directive <tt>:category:</tt>. |
|
622 | 619 | # |
623 | 620 | # ====== <tt>:category:</tt> |
624 | 621 | # |
625 | | -# - Appears on a line by itself. |
626 | | -# - Takes argument +section_title+. |
| 622 | +# - Appears on a line by itself; takes argument +section_title+ (<tt>:category: _section_title_</tt>). |
627 | 623 | # - Specifies that just one following method is to be included |
628 | 624 | # in the given section, or in the default section if no title is given. |
629 | 625 | # Subsequent methods are to be grouped into the current section. |
|
632 | 628 | # |
633 | 629 | # ====== <tt>:include:</tt> |
634 | 630 | # |
635 | | -# - Appears on a line by itself. |
636 | | -# - Takes argument +filepath+. |
| 631 | +# - Appears on a line by itself; takes argument +filepath+ (<tt>:include: _filepath_</tt>). |
637 | 632 | # - Specifies that the contents of the given file |
638 | 633 | # are to be included at this point. |
639 | 634 | # |
|
0 commit comments