From 4705fcc3c0df0d4f389aff690852356b8d2fd317 Mon Sep 17 00:00:00 2001
From: nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 12 Sep 2011 04:38:15 +0000
Subject: * README.EXT, README.EXT.ja (2.2.2), parse.y (rb_check_id): add  
 documents for rb_check_id().

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@33255 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 parse.y | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'parse.y')

diff --git a/parse.y b/parse.y
index ada62e70a6..73aaaabf33 100644
--- a/parse.y
+++ b/parse.y
@@ -10112,6 +10112,17 @@ rb_is_junk_id(ID id)
     return is_junk_id(id);
 }
 
+/**
+ * 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)
 {
-- 
cgit v1.2.3