diff options
| author | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-08-08 15:24:44 +0900 |
|---|---|---|
| committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
| commit | 1563526edffe4dfc8330ebdef23ffd25e2ac460c (patch) | |
| tree | 154cd2b28cd709e1a62fc26ff11c9c77c7fa9dc6 | |
| parent | 6e8e2b467bc2d1db0a593ddfb23eabdc109d85e1 (diff) | |
include/ruby/defines.h: add doxygen
The only thing that remains in this file which is still worth
documenting is the RUBY macro. Everything else were split into many
files in
https://github.com/ruby/ruby/pull/2991/commits/1ff4cee2b172bf7653c29a8522c132907172b975
[ci skip]
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/4815
| -rw-r--r-- | include/ruby/defines.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/include/ruby/defines.h b/include/ruby/defines.h index 66ee741954..48184f8a18 100644 --- a/include/ruby/defines.h +++ b/include/ruby/defines.h @@ -78,16 +78,24 @@ #include "ruby/internal/dosish.h" #include "ruby/missing.h" +/** + * Asserts that the compilation unit includes Ruby's CAPI. This has been here + * since the very beginning (at least since version 0.49). + */ #define RUBY #ifdef __GNUC__ +# /** This is expanded to nothing for non-GCC compilers. */ # define RB_GNUC_EXTENSION __extension__ +# /** This is expanded to the passed token for non-GCC compilers. */ # define RB_GNUC_EXTENSION_BLOCK(x) __extension__ ({ x; }) #else # define RB_GNUC_EXTENSION # define RB_GNUC_EXTENSION_BLOCK(x) (x) #endif +/** @cond INTERNAL_MACRO */ + /* :FIXME: Can someone tell us why is this macro defined here? @shyouhei * thinks this is a truly internal macro but cannot move around because he * doesn't understand the reason of this arrangement. */ @@ -104,5 +112,5 @@ RBIMPL_SYMBOL_EXPORT_END() #else # define FLUSH_REGISTER_WINDOWS ((void)0) #endif - +/** @endcond */ #endif /* RUBY_DEFINES_H */ |