Skip to content

Commit db78913

Browse files
committed
Update doc/rdoc/markup_reference.rb
1 parent 09ddef3 commit db78913

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

doc/rdoc/markup_reference.rb

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,8 @@
459459
# ====== <tt>:nodoc:</tt>
460460
#
461461
# - 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>).
463464
# - Specifies that the defined object should not be documented.
464465
#
465466
# For a method definition in C code, it the directive must be in the comment line
@@ -485,7 +486,7 @@
485486
# For a constant definition in C code, this directive <em>can not work</em>
486487
# because there is no "implementation" place for a constant.
487488
#
488-
# With argument +all+:
489+
# With argument +all+ (<tt>:nodoc: all</tt>),
489490
# specifies that the class or module should not be documented.
490491
# By default, however, a nested class or module _will_ be documented.
491492
#
@@ -528,8 +529,7 @@
528529
#
529530
# ====== <tt>:markup:</tt>
530531
#
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>).
533533
# - Specifies the format for the \RDoc input;
534534
# argument +format+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
535535
# See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
@@ -555,8 +555,7 @@
555555
#
556556
# ====== <tt>:args:</tt>
557557
#
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>).
560559
# - Specifies the arguments to be reported in the HTML,
561560
# overriding the actual arguments in the code.
562561
# See method #args_directive.
@@ -565,8 +564,7 @@
565564
#
566565
# ====== <tt>:yields:</tt>
567566
#
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>).
570568
# - Specifies the yield arguments to be reported in the HTML,
571569
# overriding the actual yield in the code.
572570
# See method #yields_directive.
@@ -585,10 +583,9 @@
585583
#
586584
# ====== <tt>:section:</tt>
587585
#
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>).
590587
# - 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+,
592589
# or into the default section if no title is given.
593590
# The directive remains in effect until another such directive is given,
594591
# but may be temporarily overridden by directive <tt>:category:</tt>.
@@ -622,8 +619,7 @@
622619
#
623620
# ====== <tt>:category:</tt>
624621
#
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>).
627623
# - Specifies that just one following method is to be included
628624
# in the given section, or in the default section if no title is given.
629625
# Subsequent methods are to be grouped into the current section.
@@ -632,8 +628,7 @@
632628
#
633629
# ====== <tt>:include:</tt>
634630
#
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>).
637632
# - Specifies that the contents of the given file
638633
# are to be included at this point.
639634
#

0 commit comments

Comments
 (0)