From 8a469f1c2575ae8a1da602affb94e74ffa6a06c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?= Date: Mon, 7 Jun 2021 13:33:08 +0900 Subject: include/ruby/backward/2/stdarg.h: add doxygen Must not be a bad idea to improve documents. [ci skip] --- include/ruby/backward/2/stdarg.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'include/ruby') 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 -- cgit v1.2.3