diff options
| -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. |