diff options
| author | Nobuyoshi Nakada <[email protected]> | 2024-12-31 21:16:47 +0900 |
|---|---|---|
| committer | git <[email protected]> | 2024-12-31 12:16:50 +0000 |
| commit | 63b141ef21497b8694e9401c934fc41c3823e3ad (patch) | |
| tree | f0fab4ffcb14123ede75827bc71474b7da1f2492 | |
| parent | 89c9a9fd03df264cb11314dd4264d79eff7be3d9 (diff) | |
[ruby/rdoc] Documentation for #1240
(https://github.com/ruby/rdoc/pull/1263)
https://github.com/ruby/rdoc/commit/5dfccda4c0
| -rw-r--r-- | doc/rdoc/markup_reference.rb | 9 |
1 files changed, 9 insertions, 0 deletions
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: <tt>DummyClass</tt> links to DummyClass. # - Off-page: <tt>RDoc::Alias</tt> links to RDoc::Alias. # +# Note: For poeple want to mark up code (such as class, module, +# constant, and method) as "<tt>+code+</tt>" (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. +# +# - <tt>+DummyClass+</tt> links to DummyClass +# - <tt>+DummyClass-object+</tt> is not a link. +# # [Module] # # - On-page: <tt>DummyModule</tt> links to DummyModule. |