summaryrefslogtreecommitdiff
path: root/compar.c
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2022-03-25 10:52:06 -0500
committerGitHub <noreply@github.com>2022-03-25 10:52:06 -0500
commitf918f6e4e74541a184a15762a8593fb3f1b9614d (patch)
tree1ba4cbb539f3a0f7c94ea98b55cc2cdc9aeb74d1 /compar.c
parent69967ee64eac9ce65b83533a566d69d12a6046d0 (diff)
downloadruby-f918f6e4e74541a184a15762a8593fb3f1b9614d.tar.gz
[DOC] Repair format and links in What's Here sections (#5711)
* Repair format and links in What's Here for Comparable and Array * Repair format for What's Here in enum.c
Diffstat (limited to 'compar.c')
-rw-r--r--compar.c20
1 files changed, 13 insertions, 7 deletions
diff --git a/compar.c b/compar.c
index c82d44c103..6ee4c2c3fa 100644
--- a/compar.c
+++ b/compar.c
@@ -288,16 +288,22 @@ cmp_clamp(int argc, VALUE *argv, VALUE x)
*
* \Module \Comparable provides these methods, all of which use method <tt><=></tt>:
*
- * - #<:: Returns whether +self+ is less than the given object.
- * - #<=:: Returns whether +self+ is less than or equal to the given object.
- * - #==:: Returns whether +self+ is equal to the given object.
- * - #>:: Returns whether +self+ is greater than or equal to the given object.
- * - #>=:: Returns whether +self+ is greater than the given object.
- * - #between? Returns +true+ if +self+ is between two given objects.
- * - #clamp:: For given objects +min+ and +max+, or range <tt>(min..max)</tt>, returns:
+ * - {<}[Comparable.html#method-i-3C]:
+ * Returns whether +self+ is less than the given object.
+ * - {<=}[Comparable.html#method-i-3C-3D]:
+ * Returns whether +self+ is less than or equal to the given object.
+ * - #==: Returns whether +self+ is equal to the given object.
+ * - {>}[Comparable.html#method-i-3E]:
+ * Returns whether +self+ is greater than or equal to the given object.
+ * - {>=}[Comparable.html#method-i-3E-3D]:
+ * Returns whether +self+ is greater than the given object.
+ * - #between?: Returns +true+ if +self+ is between two given objects.
+ * - #clamp: For given objects +min+ and +max+, or range <tt>(min..max)</tt>, returns:
+ *
* - +min+ if <tt>(self <=> min) < 0</tt>.
* - +max+ if <tt>(self <=> max) > 0</tt>.
* - +self+ otherwise.
+ *
*/
void