[DOC] Use RDoc link style for links to other classes/modules

I used this regex:

([A-Za-z]+)\.html#(?:class|module)-[A-Za-z]+-label-([A-Za-z0-9\-\+]+)

And performed a global find & replace for this:

rdoc-ref:$1@$2
This commit is contained in:
Peter Zhu 2022-02-06 10:30:11 -05:00
parent ecd469fad0
commit f9a2802bc5
Notes: git 2022-02-07 23:52:32 +09:00
9 changed files with 29 additions and 29 deletions

View File

@ -8080,8 +8080,8 @@ rb_ary_deconstruct(VALUE ary)
*
* First, what's elsewhere. \Class \Array:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
* which provides dozens of additional methods.
*
* Here, class \Array provides methods that are useful for:

4
file.c
View File

@ -6577,9 +6577,9 @@ const char ruby_null_device[] =
*
* First, what's elsewhere. \Class \File:
*
* - Inherits from {class IO}[IO.html#class-IO-label-What-27s+Here],
* - Inherits from {class IO}[rdoc-ref:IO@What-27s+Here],
* in particular, methods for creating, reading, and writing files
* - Includes {module FileTest}[FileTest.html#module-FileTest-label-What-27s+Here].
* - Includes {module FileTest}[rdoc-ref:FileTest@What-27s+Here].
* which provides dozens of additional methods.
*
* Here, class \File provides methods that are useful for:

8
hash.c
View File

@ -7014,8 +7014,8 @@ static const rb_data_type_t env_data_type = {
*
* First, what's elsewhere. \Class \Hash:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
* which provides dozens of additional methods.
*
* Here, class \Hash provides methods that are useful for:
@ -7327,8 +7327,8 @@ Init_Hash(void)
*
* First, what's elsewhere. \Class \ENV:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Extends {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Extends {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
*
* Here, class \ENV provides methods that are useful for:
*

14
io.c
View File

@ -9715,12 +9715,12 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
*
* Returns an array containing the lines returned by calling
* Kernel#gets until the end-of-file is reached;
* (see {Lines}[IO.html#class-IO-label-Lines]).
* (see {Lines}[rdoc-ref:IO@Lines]).
*
* With only string argument +sep+ given,
* returns the remaining lines as determined by line separator +sep+,
* or +nil+ if none;
* see {Line Separator}[IO.html#class-IO-label-Line+Separator].\:
* see {Line Separator}[rdoc-ref:IO@Line+Separator].\:
*
* # Default separator.
* $ cat t.txt | ruby -e "p readlines"
@ -9740,7 +9740,7 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
*
* With only integer argument +limit+ given,
* limits the number of bytes in the line;
* see {Line Limit}}[IO.html#class-IO-label-Line+Limit]:
* see {Line Limit}}[rdoc-ref:IO@Line+Limit]:
*
* $cat t.txt | ruby -e "p readlines 10"
* ["First line", "\n", "Second lin", "e\n", "\n", "Fourth lin", "e\n", "Fifth line", "\n"]
@ -9752,10 +9752,10 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
* ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"]
*
* With arguments +sep+ and +limit+ given, combines the two behaviors;
* see {Line Separator and Line Limit}[IO.html#class-IO-label-Line+Separator+and+Line+Limit].
* see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit].
*
* For all forms above, trailing optional keyword arguments may be given;
* see {Line Options}[IO.html#class-IO-label-Line+Options]:
* see {Line Options}[rdoc-ref:IO@Line+Options]:
*
* $ cat t.txt | ruby -e "p readlines(chomp: true)"
* ["First line", "Second line", "", "Fourth line", "Fifth line"]
@ -14376,8 +14376,8 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y)
*
* First, what's elsewhere. \Class \IO:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
* which provides dozens of additional methods.
*
* Here, class \IO provides methods that are useful for:

View File

@ -958,7 +958,7 @@ num_negative_p(VALUE num)
*
* First, what's elsewhere. \Class \Float:
*
* - Inherits from {class Numeric}[Numeric.html#class-Numeric-label-What-27s+Here].
* - Inherits from {class Numeric}[rdoc-ref:Numeric@What-27s+Here].
*
* Here, class \Float provides methods for:
*
@ -3495,7 +3495,7 @@ rb_num2ull(VALUE val)
*
* First, what's elsewhere. \Class \Integer:
*
* - Inherits from {class Numeric}[Numeric.html#class-Numeric-label-What-27s+Here].
* - Inherits from {class Numeric}[rdoc-ref:Numeric@What-27s+Here].
*
* Here, class \Integer provides methods for:
*
@ -6099,8 +6099,8 @@ int_s_try_convert(VALUE self, VALUE num)
*
* First, what's elsewhere. \Class \Numeric:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
*
* Here, class \Numeric provides methods for:
*

View File

@ -4162,8 +4162,8 @@ f_sprintf(int c, const VALUE *v, VALUE _)
*
* First, what's elsewhere. \Class \Object:
*
* - Inherits from {class BasicObject}[BasicObject.html#class-BasicObject-label-What-27s+Here].
* - Includes {module Kernel}[Kernel.html#module-Kernel-label-What-27s+Here].
* - Inherits from {class BasicObject}[rdoc-ref:BasicObject@What-27s+Here].
* - Includes {module Kernel}[rdoc-ref:Kernel@What-27s+Here].
*
* Here, class \Object provides methods for:
*

View File

@ -2207,8 +2207,8 @@ range_count(int argc, VALUE *argv, VALUE range)
*
* First, what's elsewhere. \Class \Range:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
* which provides dozens of additional methods.
*
* Here, class \Range provides methods that are useful for:

View File

@ -11291,8 +11291,8 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
*
* First, what's elsewhere. \Class \Symbol:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
*
* Here, class \Symbol provides methods that are useful for:
*
@ -12095,8 +12095,8 @@ rb_enc_interned_str_cstr(const char *ptr, rb_encoding *enc)
*
* First, what's elsewhere. \Class \String:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
*
* Here, class \String provides methods that are useful for:
*

View File

@ -1562,8 +1562,8 @@ rb_struct_dig(int argc, VALUE *argv, VALUE self)
*
* First, what's elsewhere. \Class \Struct:
*
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
* which provides dozens of additional methods.
*
* Here, class \Struct provides methods that are useful for: