include/ruby/internal/core/rstruct.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]

2 files changed, 53 insertions, 5 deletions

diff --git a/include/ruby/internal/core/rstruct.h b/include/ruby/internal/core/rstruct.h
index 88b27eeb1a..69be487b59 100644
--- a/include/ruby/internal/core/rstruct.h
+++ b/include/ruby/internal/core/rstruct.h
@@ -18,7 +18,8 @@
  *             Do not  expect for  instance `__VA_ARGS__` is  always available.
  *             We assume C99  for ruby itself but we don't  assume languages of
  *             extension libraries.  They could be written in C++98.
- * @brief      Routines to manipulate struct ::RStruct.
+ * @brief      Routines to manipulate struct RStruct.
+ * @note       The struct RStruct itself is opaque.
  */
 #include "ruby/internal/attr/artificial.h"
 #include "ruby/internal/dllexport.h"
@@ -30,6 +31,17 @@
 # include "ruby/backward.h"
 #endif
 
+/**
+ * @private
+ *
+ * @deprecated  This macro once was a thing in the old days, but makes no sense
+ *              any  longer today.   Exists  here  for backwards  compatibility
+ *              only.  You can safely forget about it.
+ *
+ * @internal
+ *
+ * Declaration of rb_struct_ptr() is at include/ruby/backward.h.
+ */
 #define RSTRUCT_PTR(st) rb_struct_ptr(st)
 /** @cond INTERNAL_MACRO */
 #define RSTRUCT_LEN RSTRUCT_LEN
@@ -38,12 +50,46 @@
 /** @endcond */
 
 RBIMPL_SYMBOL_EXPORT_BEGIN()
-VALUE rb_struct_size(VALUE s);
-VALUE rb_struct_aref(VALUE, VALUE);
-VALUE rb_struct_aset(VALUE, VALUE, VALUE);
+/**
+ * Returns the number of struct members.
+ *
+ * @param[in]  st  An instance of RStruct.
+ * @return     The number of members of `st`.
+ * @pre        `st` must be of ::RUBY_T_STRUCT.
+ */
+VALUE rb_struct_size(VALUE st);
+
+/**
+ * Resembles `Struct#[]`.
+ *
+ * @param[in]  st              An instance of RStruct.
+ * @param[in]  k               Index a.k.a. key of the struct.
+ * @exception  rb_eTypeError   `k` is neither Numeric, Symbol, nor String.
+ * @exception  rb_eIndexError  Numerical index out of range.
+ * @exception  rb_eNameError   No such key.
+ * @return     The member stored at `k` in `st`.
+ * @pre        `st` must be of ::RUBY_T_STRUCT.
+ */
+VALUE rb_struct_aref(VALUE st, VALUE k);
+
+/**
+ * Resembles `Struct#[]=`.
+ *
+ * @param[out]  st              An instance of RStruct.
+ * @param[in]   k               Index a.k.a. key of the struct.
+ * @param[in]   v               Value to store.
+ * @exception  rb_eTypeError    `k` is neither Numeric, Symbol, nor String.
+ * @exception  rb_eIndexError   Numerical index out of range.
+ * @exception  rb_eNameError    No such key.
+ * @return     Passed `v`.
+ * @pre        `st` must be of ::RUBY_T_STRUCT.
+ * @post       `v` is stored at `k` in `st`.
+ */
+VALUE rb_struct_aset(VALUE st, VALUE k, VALUE v);
 RBIMPL_SYMBOL_EXPORT_END()
 
 RBIMPL_ATTR_ARTIFICIAL()
+/** @copydoc rb_struct_size()  */
 static inline long
 RSTRUCT_LEN(VALUE st)
 {
@@ -53,6 +99,7 @@ RSTRUCT_LEN(VALUE st)
 }
 
 RBIMPL_ATTR_ARTIFICIAL()
+/** @copydoc rb_struct_aset()  */
 static inline VALUE
 RSTRUCT_SET(VALUE st, int k, VALUE v)
 {
@@ -62,6 +109,7 @@ RSTRUCT_SET(VALUE st, int k, VALUE v)
 }
 
 RBIMPL_ATTR_ARTIFICIAL()
+/** @copydoc rb_struct_aref()  */
 static inline VALUE
 RSTRUCT_GET(VALUE st, int k)
 {
diff --git a/include/ruby/internal/intern/struct.h b/include/ruby/internal/intern/struct.h
index 373bf150e4..d39f4c1c8a 100644
--- a/include/ruby/internal/intern/struct.h
+++ b/include/ruby/internal/intern/struct.h
@@ -37,7 +37,7 @@ VALUE rb_struct_aset(VALUE, VALUE, VALUE);
 VALUE rb_struct_getmember(VALUE, ID);
 VALUE rb_struct_s_members(VALUE);
 VALUE rb_struct_members(VALUE);
-VALUE rb_struct_size(VALUE s);
+VALUE rb_struct_size(VALUE);
 VALUE rb_struct_alloc_noinit(VALUE);
 VALUE rb_struct_define_without_accessor(const char *, VALUE, rb_alloc_func_t, ...);
 VALUE rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, ...);