summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--include/ruby/defines.h10
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 */