kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[DOC] Added document for rb_check_symbol() [ci skip]

Browse source
This commit is contained in:
Nobuyoshi Nakada 2020-05-24 10:53:12 +09:00
parent 8b8b7c7876
commit b10c9d2012
No known key found for this signature in database
GPG key ID: 7CD2805BFA3770C6
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
symbol.c
View file

@ -957,6 +957,18 @@ 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)
{