1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

include/ruby/internal/intern/compar.h: add doxygen

Browse Source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-05-13 14:06:12 +09:00
parent 0375f1fe97
commit 5f478d8ac3
Notes: git 2021-09-10 20:01:26 +09:00 
Merged: https://github.com/ruby/ruby/pull/4815
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
include/ruby/internal/intern/compar.h
View File

@ -20,14 +20,42 @@
* extension libraries. They could be written in C++98.
* @brief Public APIs related to ::rb_mComparable.
*/
#include "ruby/internal/attr/cold.h"
#include "ruby/internal/attr/noreturn.h"
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
RBIMPL_SYMBOL_EXPORT_BEGIN()
/* bignum.c */
/**
* Canonicalises the passed `val`, which is the return value of `a <=> b`, into
* C's `{-1, 0, 1}`. This can be handy when you implement a callback function
* to pass to `qsort(3)` etc.
*
* @param[in] val Return value of a space ship operator.
* @param[in] a Comparison LHS.
* @param[in] b Comparison RHS.
* @exception rb_eArgError `a` and `b` are not comparable each other.
* @retval -1 `val` is less than zero.
* @retval 0 `val` is equal to zero.
* @retval 1 `val` is greater than zero.
*/
int rb_cmpint(VALUE val, VALUE a, VALUE b);
/* compar.c */
int rb_cmpint(VALUE, VALUE, VALUE);
NORETURN(void rb_cmperr(VALUE, VALUE));
RBIMPL_ATTR_COLD()
RBIMPL_ATTR_NORETURN()
/**
* Raises "comparison failed" error.
*
* @param[in] a Comparison LHS.
* @param[in] b Comparison RHS.
* @exception rb_eArgError `a` and `b` are not comparable each other.
*/
void rb_cmperr(VALUE a, VALUE b);
RBIMPL_SYMBOL_EXPORT_END()