archive/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2025-08-15 13:39:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

include/ruby/internal/symbol.h: add doxygen

Browse source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-01-12 17:11:48 +09:00
parent 178ce74597
commit 73d2bf97c1
Notes: git 2021-09-10 20:01:53 +09:00
2 changed files with 236 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

23
symbol.c
View file

@ -1053,17 +1053,6 @@ rb_is_attrset_sym(VALUE sym)
return is_attrset_sym(sym);
}
/**
* Returns ID for the given name if it is interned already, or 0.
*
* \param namep the pointer to the name object
* \return the ID for *namep
* \pre the object referred by \p namep must be a Symbol or
* a String, or possible to convert with to_str method.
* \post the object referred by \p namep is a Symbol or a
* String if non-zero value is returned, or is a String
* if 0 is returned.
*/
ID
rb_check_id(volatile VALUE *namep)
{
@ -1097,18 +1086,6 @@ rb_check_id(volatile VALUE *namep)
return lookup_str_id(name);
}
/**
* Returns Symbol for the given name if it is interned already, or
* nil.
*
* \param namep the pointer to the name object
* \return the Symbol for *namep
* \pre the object referred by \p namep must be a Symbol or
* a String, or possible to convert with to_str method.
* \post the object referred by \p namep is a Symbol or a
* String if non-nil value is returned, or is a String
* if nil is returned.
*/
VALUE
rb_check_symbol(volatile VALUE *namep)
{