From b5e491fb456cb4decdd27e91584aa3c8023173ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?= Date: Thu, 21 Jan 2021 11:32:14 +0900 Subject: [PATCH] include/ruby/internal/compiler_is: skip doxygen We don't want 3rd parties to use these RBIMPL_ macros. Let's not document them. [ci skip] --- include/ruby/internal/compiler_is/apple.h | 3 +-- include/ruby/internal/compiler_is/clang.h | 3 +-- include/ruby/internal/compiler_is/gcc.h | 3 +-- include/ruby/internal/compiler_is/intel.h | 3 +-- include/ruby/internal/compiler_is/msvc.h | 3 +-- include/ruby/internal/compiler_is/sunpro.h | 3 +-- 6 files changed, 6 insertions(+), 12 deletions(-) diff --git a/include/ruby/internal/compiler_is/apple.h b/include/ruby/internal/compiler_is/apple.h index dd8c5b4a39..a81f1f2c8f 100644 --- a/include/ruby/internal/compiler_is/apple.h +++ b/include/ruby/internal/compiler_is/apple.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_APPLE_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_APPLE_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_Apple. + * @brief Defines RBIMPL_COMPILER_IS_Apple. * * Apple ships clang. Problem is, its `__clang_major__` etc. are not the * upstream LLVM version, but XCode's. We have to think Apple's is distinct diff --git a/include/ruby/internal/compiler_is/clang.h b/include/ruby/internal/compiler_is/clang.h index aa4a429eff..169ff789f6 100644 --- a/include/ruby/internal/compiler_is/clang.h +++ b/include/ruby/internal/compiler_is/clang.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_CLANG_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_CLANG_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_Clang. + * @brief Defines RBIMPL_COMPILER_IS_Clang. */ #include "ruby/internal/compiler_is/apple.h" diff --git a/include/ruby/internal/compiler_is/gcc.h b/include/ruby/internal/compiler_is/gcc.h index 57a1b971c3..accc80e9aa 100644 --- a/include/ruby/internal/compiler_is/gcc.h +++ b/include/ruby/internal/compiler_is/gcc.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_GCC_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_GCC_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_GCC. + * @brief Defines RBIMPL_COMPILER_IS_GCC. */ #include "ruby/internal/compiler_is/apple.h" #include "ruby/internal/compiler_is/clang.h" diff --git a/include/ruby/internal/compiler_is/intel.h b/include/ruby/internal/compiler_is/intel.h index b48bfefeba..377946ace0 100644 --- a/include/ruby/internal/compiler_is/intel.h +++ b/include/ruby/internal/compiler_is/intel.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_INTEL_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_INTEL_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_Intel. + * @brief Defines RBIMPL_COMPILER_IS_Intel. */ #if ! defined(__INTEL_COMPILER) # define RBIMPL_COMPILER_IS_Intel 0 diff --git a/include/ruby/internal/compiler_is/msvc.h b/include/ruby/internal/compiler_is/msvc.h index 1107fe7f39..8a864ea558 100644 --- a/include/ruby/internal/compiler_is/msvc.h +++ b/include/ruby/internal/compiler_is/msvc.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_MSVC_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_MSVC_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_MSVC. + * @brief Defines RBIMPL_COMPILER_IS_MSVC. */ #include "ruby/internal/compiler_is/clang.h" #include "ruby/internal/compiler_is/intel.h" diff --git a/include/ruby/internal/compiler_is/sunpro.h b/include/ruby/internal/compiler_is/sunpro.h index f714155f58..c11c8452e7 100644 --- a/include/ruby/internal/compiler_is/sunpro.h +++ b/include/ruby/internal/compiler_is/sunpro.h @@ -1,7 +1,6 @@ #ifndef RBIMPL_COMPILER_IS_SUNPRO_H /*-*-C++-*-vi:se ft=cpp:*/ #define RBIMPL_COMPILER_IS_SUNPRO_H /** - * @file * @author Ruby developers * @copyright This file is a part of the programming language Ruby. * Permission is hereby granted, to either redistribute and/or @@ -18,7 +17,7 @@ * Do not expect for instance `__VA_ARGS__` is always available. * We assume C99 for ruby itself but we don't assume languages of * extension libraries. They could be written in C++98. - * @brief Defines #RBIMPL_COMPILER_IS_SunPro. + * @brief Defines RBIMPL_COMPILER_IS_SunPro. */ #if ! (defined(__SUNPRO_C) || defined(__SUNPRO_CC)) # define RBIMPL_COMPILER_IS_SunPro 0