diff options
author | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-06-07 13:33:08 +0900 |
---|---|---|
committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
commit | 8a469f1c2575ae8a1da602affb94e74ffa6a06c3 (patch) | |
tree | 43cff007a6dbe83808da060e1b3b9b53afebba8e /include/ruby/backward | |
parent | 5453031fd468b06e0401d3d53cb963454ae5aaef (diff) | |
download | ruby-8a469f1c2575ae8a1da602affb94e74ffa6a06c3.tar.gz |
include/ruby/backward/2/stdarg.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
Diffstat (limited to 'include/ruby/backward')
-rw-r--r-- | include/ruby/backward/2/stdarg.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/include/ruby/backward/2/stdarg.h b/include/ruby/backward/2/stdarg.h index cfe2b899fd..08659fee47 100644 --- a/include/ruby/backward/2/stdarg.h +++ b/include/ruby/backward/2/stdarg.h @@ -25,6 +25,10 @@ */ #undef _ +/** + * @deprecated Nobody practically needs this macro any longer. + * @brief This was a transition path from K&R to ANSI. + */ #ifdef HAVE_PROTOTYPES # define _(args) args #else @@ -32,12 +36,30 @@ #endif #undef __ +/** + * @deprecated Nobody practically needs this macro any longer. + * @brief This was a transition path from K&R to ANSI. + */ #ifdef HAVE_STDARG_PROTOTYPES # define __(args) args #else # define __(args) () #endif +/** + * Functions declared using this macro take arbitrary arguments, including + * void. + * + * ```CXX + * void func(ANYARGS); + * ``` + * + * This was a necessary evil when there was no such thing like function + * overloading. But it is the 21st century today. People generally need not + * use this. Just use a granular typed function. + * + * @see ruby::backward::cxxanyargs + */ #ifdef __cplusplus #define ANYARGS ... #else |