diff options
author | sonots <sonots@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-10-21 14:31:21 +0000 |
---|---|---|
committer | sonots <sonots@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-10-21 14:31:21 +0000 |
commit | 47dd9bf7d819b1f905c53d1acc74fa5806ec7fe2 (patch) | |
tree | b8bfcaf0a148fbca1f07e95f9db23f9425d18367 /internal.h | |
parent | 0686d5f4eb488d96d2688aebbdcd54e5b81eb779 (diff) |
Add doxygen comments
* include/ruby/ruby.h (enum ruby_value_type): add doxygen comments
* internal.h (enum imemo_type, struct vm_svar): add doxygen comments
* method.h (rb_method_type_t, rb_method_iseq_t): add doxygen comments
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60285 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'internal.h')
-rw-r--r-- | internal.h | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/internal.h b/internal.h index 7f21eb5a01..6175949351 100644 --- a/internal.h +++ b/internal.h @@ -837,10 +837,10 @@ struct RIMemo { enum imemo_type { imemo_env = 0, - imemo_cref = 1, - imemo_svar = 2, + imemo_cref = 1, /*!< class reference */ + imemo_svar = 2, /*!< special variable */ imemo_throw_data = 3, - imemo_ifunc = 4, + imemo_ifunc = 4, /*!< iterator function */ imemo_memo = 5, imemo_ment = 6, imemo_iseq = 7, @@ -877,22 +877,21 @@ imemo_type_p(VALUE imemo, enum imemo_type imemo_type) #define IMEMO_FL_USER3 FL_USER7 #define IMEMO_FL_USER4 FL_USER8 -/* CREF in method.h */ - -/* SVAR */ +/* CREF (Class REFerence) is defined in method.h */ +/*! SVAR (Special VARiable) */ struct vm_svar { VALUE flags; - const VALUE cref_or_me; + const VALUE cref_or_me; /*!< class reference or rb_method_entry_t */ const VALUE lastline; const VALUE backref; const VALUE others; }; -/* THROW_DATA */ #define THROW_DATA_CONSUMED IMEMO_FL_USER0 +/*! THROW_DATA */ struct vm_throw_data { VALUE flags; VALUE reserved; @@ -903,7 +902,7 @@ struct vm_throw_data { #define THROW_DATA_P(err) RB_TYPE_P((VALUE)(err), T_IMEMO) -/* IFUNC */ +/* IFUNC (Internal FUNCtion) */ struct vm_ifunc_argc { #if SIZEOF_INT * 2 > SIZEOF_VALUE @@ -914,6 +913,7 @@ struct vm_ifunc_argc { #endif }; +/*! IFUNC (Internal FUNCtion) */ struct vm_ifunc { VALUE flags; VALUE reserved; @@ -938,8 +938,10 @@ typedef struct rb_imemo_alloc_struct { size_t cnt; /* buffer size in VALUE */ } rb_imemo_alloc_t; -/* MEMO */ - +/*! MEMO + * + * @see imemo_type + * */ struct MEMO { VALUE flags; VALUE reserved; |