https://git.ruby-lang.org/ruby.git/commit/?id=1563526edf

From 1563526edffe4dfc8330ebdef23ffd25e2ac460c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@r...>
Date: Sun, 8 Aug 2021 15:24:44 +0900
Subject: 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]
---
 include/ruby/defines.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/include/ruby/defines.h b/include/ruby/defines.h
index 66ee741..48184f8 100644
--- a/include/ruby/defines.h
+++ b/include/ruby/defines.h
@@ -78,16 +78,24 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/defines.h#L78
 #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() https://github.com/ruby/ruby/blob/trunk/include/ruby/defines.h#L112
 #else
 # define FLUSH_REGISTER_WINDOWS ((void)0)
 #endif
-
+/** @endcond */
 #endif /* RUBY_DEFINES_H */
-- 
cgit v1.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/