From 63b141ef21497b8694e9401c934fc41c3823e3ad Mon Sep 17 00:00:00 2001 From: Nobuyoshi Nakada Date: Tue, 31 Dec 2024 21:16:47 +0900 Subject: [PATCH] [ruby/rdoc] Documentation for #1240 (https://github.com/ruby/rdoc/pull/1263) https://github.com/ruby/rdoc/commit/5dfccda4c0 --- doc/rdoc/markup_reference.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb index 5b5cdfc706..7622dde0b6 100644 --- a/doc/rdoc/markup_reference.rb +++ b/doc/rdoc/markup_reference.rb @@ -859,6 +859,15 @@ require 'rdoc' # - On-page: DummyClass links to DummyClass. # - Off-page: RDoc::Alias links to RDoc::Alias. # +# Note: For poeple want to mark up code (such as class, module, +# constant, and method) as "+code+" (for interoperability +# with other MarkDown parsers mainly), such word that refers a known +# code object and is marked up entirely and separately as "monofont" +# is also converted to a link. +# +# - +DummyClass+ links to DummyClass +# - +DummyClass-object+ is not a link. +# # [Module] # # - On-page: DummyModule links to DummyModule.