summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2020-12-07 12:37:18 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2020-12-07 14:20:44 +0900
commitcc36e499f9403c2e3dd0514fc8f13ff485c10b82 (patch)
treee9f65fc02bd4e403ab7845d39a67ac17a7c6f823
parent5d8bcc4870601ab1ee05346346f241d4a805aac9 (diff)
Doxygen terminology update [ci skip]
Follow N2328 http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2328.pdf
-rw-r--r--include/ruby/internal/xmalloc.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/include/ruby/internal/xmalloc.h b/include/ruby/internal/xmalloc.h
index fc04d02889..af5e8637a9 100644
--- a/include/ruby/internal/xmalloc.h
+++ b/include/ruby/internal/xmalloc.h
@@ -55,7 +55,7 @@ RBIMPL_ATTR_RESTRICT()
RBIMPL_ATTR_RETURNS_NONNULL()
RBIMPL_ATTR_ALLOC_SIZE((1))
/**
- * Allocates an object instance. It is largely the same as system malloc(),
+ * Allocates a storage instance. It is largely the same as system malloc(),
* except:
*
* - It raises Ruby exceptions instead of returning NULL, and
@@ -142,19 +142,19 @@ RBIMPL_ATTR_NODISCARD()
RBIMPL_ATTR_RETURNS_NONNULL()
RBIMPL_ATTR_ALLOC_SIZE((2))
/**
- * Resize the object instance.
+ * Resize the storage instance.
*
- * @param[in] ptr A valid pointer to an object instance that was
+ * @param[in] ptr A valid pointer to a storage instance that was
* previously returned from either ruby_xmalloc(),
* ruby_xmalloc2(), ruby_xcalloc(), ruby_xrealloc(),
* or ruby_xrealloc2().
* @param[in] newsiz Requested new amount of memory.
* @throw rb_eMemError No space left for `newsiz` bytes allocation.
* @retval ptr In case the function returns the passed pointer
- * as-is, the object instance that the pointer holds
+ * as-is, the storage instance that the pointer holds
* is either grown or shrunken to have at least
* `newsiz` bytes.
- * @retval otherwise A valid pointer to a newly allocated object
+ * @retval otherwise A valid pointer to a newly allocated storage
* instance which has at least `newsiz` bytes width,
* and holds previous contents of `ptr`. In this
* case `ptr` is invalidated as if it was passed to
@@ -182,8 +182,8 @@ RBIMPL_ATTR_NODISCARD()
RBIMPL_ATTR_RETURNS_NONNULL()
RBIMPL_ATTR_ALLOC_SIZE((2,3))
/**
- * Identical to ruby_xrealloc(), except it resizes the given object instance to
- * `newelems` * `newsiz` bytes. This is needed because the multiplication
+ * Identical to ruby_xrealloc(), except it resizes the given storage instance
+ * to `newelems` * `newsiz` bytes. This is needed because the multiplication
* could integer overflow. On such situations Ruby does not try to touch the
* contents of argument pointer at all but raises Ruby level exceptions
* instead. If there is no integer overflow the behaviour is exactly the same
@@ -192,7 +192,7 @@ RBIMPL_ATTR_ALLOC_SIZE((2,3))
* This is roughly the same as reallocarray() function that OpenBSD
* etc. provides, but also interacts with our GC.
*
- * @param[in] ptr A valid pointer to an object instance that was
+ * @param[in] ptr A valid pointer to a storage instance that was
* previously returned from either ruby_xmalloc(),
* ruby_xmalloc2(), ruby_xcalloc(), ruby_xrealloc(),
* or ruby_xrealloc2().
@@ -201,10 +201,10 @@ RBIMPL_ATTR_ALLOC_SIZE((2,3))
* @throw rb_eMemError No space left for allocation.
* @throw rb_eArgError `newelems` * `newsiz` would overflow.
* @retval ptr In case the function returns the passed pointer
- * as-is, the object instance that the pointer holds
+ * as-is, the storage instance that the pointer holds
* is either grown or shrunken to have at least
* `newelems` * `newsiz` bytes.
- * @retval otherwise A valid pointer to a newly allocated object
+ * @retval otherwise A valid pointer to a newly allocated storage
* instance which has at least `newelems` * `newsiz`
* bytes width, and holds previous contents of `ptr`.
* In this case `ptr` is invalidated as if it was
@@ -230,12 +230,12 @@ RBIMPL_ATTR_NOEXCEPT(realloc(ptr, newelems * newsiz))
;
/**
- * Deallocates an object instance.
+ * Deallocates a storage instance.
*
* @param[out] ptr Either NULL, or a valid pointer previously returned from
* one of ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2().
- * @warning Every single object instance that was previously allocated by
+ * @warning Every single storage instance that was previously allocated by
* either ruby_xmalloc(), ruby_xmalloc2(), ruby_xcalloc(),
* ruby_xrealloc(), or ruby_xrealloc2() shall be invalidated
* exactly once by either passing it to ruby_xfree(), or passing