|
972 | 972 | # if that item exists.
|
973 | 973 | # The referenced item may be a class, module, method, file, etc.
|
974 | 974 | #
|
975 |
| -# - Class: <tt>Alias[rdoc-ref:RDoc::Alias]</tt> links to Alias[rdoc-ref:RDoc::Alias]. |
976 |
| -# - Module: <tt>RDoc[rdoc-ref:RDoc]</tt> links to RDoc[rdoc-ref:RDoc]. |
977 |
| -# - Method: <tt>foo[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]</tt> |
978 |
| -# links to foo[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]. |
979 |
| -# - Constant: <tt>bar[rdoc-ref:RDoc::Markup::ToHtml::LIST_TYPE_TO_HTML]</tt> |
980 |
| -# links to bar[rdoc-ref:RDoc::Markup::ToHtml::LIST_TYPE_TO_HTML]. |
981 |
| -# - Attribute: <tt>baz[rdoc-ref:RDoc::Markup::ToHtml#code_object]</tt> |
982 |
| -# links to baz[rdoc-ref:RDoc::Markup::ToHtml#code_object]. |
983 |
| -# - Alias: <tt>bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]</tt> links to |
984 |
| -# bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]. |
| 975 | +# - Class: <tt>Alias[rdoc-ref:RDoc::Alias]</tt> generates Alias[rdoc-ref:RDoc::Alias]. |
| 976 | +# - Module: <tt>RDoc[rdoc-ref:RDoc]</tt> generates RDoc[rdoc-ref:RDoc]. |
| 977 | +# - Method: <tt>foo[rdoc-ref:RDoc::MarkupReference#dummy_instance_method]</tt> |
| 978 | +# generates foo[rdoc-ref:RDoc::MarkupReference#dummy_instance_method]. |
| 979 | +# - Constant: <tt>bar[rdoc-ref:RDoc::MarkupReference::DUMMY_CONSTANT]</tt> |
| 980 | +# generates bar[rdoc-ref:RDoc::MarkupReference::DUMMY_CONSTANT]. |
| 981 | +# - Attribute: <tt>baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute]</tt> |
| 982 | +# generates baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute]. |
| 983 | +# - Alias: <tt>bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]</tt> |
| 984 | +# generates bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]. |
985 | 985 | #
|
986 | 986 | # If the referenced item does not exist, no link is generated
|
987 | 987 | # and entire <tt>rdoc-ref:</tt> square-bracketed clause is removed
|
988 | 988 | # from the resulting text.
|
989 | 989 | #
|
990 |
| -# - <tt>Nosuch[rdoc-ref:RDoc::Nosuch]</tt> is rendered as |
| 990 | +# - <tt>Nosuch[rdoc-ref:RDoc::Nosuch]</tt> generates |
991 | 991 | # Nosuch[rdoc-ref:RDoc::Nosuch].
|
992 | 992 | #
|
993 | 993 | #
|
|
0 commit comments