Skip to content

Commit 961085d

Browse files
committed
Update RDoc::Markup to explain rdoc-ref: and fix unclosed tt
1 parent 88af43d commit 961085d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

lib/rdoc/markup.rb

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,19 @@
284284
#
285285
# Links can also be of the form <tt>label[url]</tt>, in which case +label+ is
286286
# used in the displayed text, and +url+ is used as the target. If +label+
287-
# contains multiple words, put it in braces: <tt>{multi word label}[url]<tt>.
287+
# contains multiple words, put it in braces: <tt>{multi word label}[url]</tt>.
288+
# The +url+ may be an +http:+-type link or a cross-reference to a class,
289+
# module or method with a label.
290+
#
291+
# Links with the <tt>rdoc-ref:</tt> scheme will link to the referenced class,
292+
# module, method, file, etc. If the referenced item is does not exist
293+
# no link will be generated and <tt>rdoc-ref:</tt> will be removed from the
294+
# resulting text.
295+
#
296+
# Links starting with +link:+ refer to local files whose path is relative to
297+
# the <tt>--op</tt> directory. Use <tt>rdoc-ref:</tt> instead of
298+
# <tt>link:</tt> to link to files generated by RDoc as the link target may
299+
# be different across RDoc generators.
288300
#
289301
# Example links:
290302
#

0 commit comments

Comments
 (0)