|
502 | 502 | # Starts a new section in the output. The title following +:section:+ is
|
503 | 503 | # used as the section heading, and the remainder of the comment containing
|
504 | 504 | # the section is used as introductory text. Subsequent methods, aliases,
|
505 |
| -# attributes, and classes will be documented in this section. A :section: |
506 |
| -# comment block may have one or more lines before the :section: directive. |
507 |
| -# These will be removed, and any identical lines at the end of the block are |
508 |
| -# also removed. This allows you to add visual cues such as: |
| 505 | +# attributes, and classes will be documented in this section. |
| 506 | +# |
| 507 | +# A :section: comment block may have one or more lines before the :section: |
| 508 | +# directive. These will be removed, and any identical lines at the end of |
| 509 | +# the block are also removed. This allows you to add visual cues such as: |
509 | 510 | #
|
510 | 511 | # # ----------------------------------------
|
511 | 512 | # # :section: My Section
|
512 | 513 | # # This is the section that I wrote.
|
513 | 514 | # # See it glisten in the noon-day sun.
|
514 | 515 | # # ----------------------------------------
|
515 | 516 | #
|
516 |
| -# <i>Note: Current formatters to not take sections into account.</i> |
| 517 | +# Sections may be referenced multiple times in a class or module allowing |
| 518 | +# methods, attributes and constants to be ordered one way for implementation |
| 519 | +# ordering but still grouped together in documentation. If a section has |
| 520 | +# multiple comments they will be concatenated with a dividing rule. |
517 | 521 | #
|
518 | 522 | # [+:call-seq:+]
|
519 | 523 | # Lines up to the next blank line in the comment are treated as the method's
|
|
0 commit comments