[前][次][番号順一覧][スレッド一覧]

ruby-changes:67814

From: =E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3 <ko1@a...>
Date: Fri, 10 Sep 2021 20:02:19 +0900 (JST)
Subject: [ruby-changes:67814] 8a469f1c25 (master): include/ruby/backward/2/stdarg.h: add doxygen

https://git.ruby-lang.org/ruby.git/commit/?id=8a469f1c25

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?=
 <shyouhei@r...>
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(+)

diff --git a/include/ruby/backward/2/stdarg.h b/include/ruby/backward/2/stdarg.h
index cfe2b89..08659fe 100644
--- a/include/ruby/backward/2/stdarg.h
+++ b/include/ruby/backward/2/stdarg.h
@@ -25,6 +25,10 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/backward/2/stdarg.h#L25
  */
 
 #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 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/backward/2/stdarg.h#L36
 #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.1


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

[前][次][番号順一覧][スレッド一覧]