summaryrefslogtreecommitdiff
path: root/Modules/TestCXXAcceptsFlag.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'Modules/TestCXXAcceptsFlag.cmake')
-rw-r--r--Modules/TestCXXAcceptsFlag.cmake32
1 files changed, 15 insertions, 17 deletions
diff --git a/Modules/TestCXXAcceptsFlag.cmake b/Modules/TestCXXAcceptsFlag.cmake
index 2694737ef..10019ec68 100644
--- a/Modules/TestCXXAcceptsFlag.cmake
+++ b/Modules/TestCXXAcceptsFlag.cmake
@@ -1,24 +1,22 @@
-# - Test CXX compiler for a flag
-# Check if the CXX compiler accepts a flag
+# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#.rst:
+# TestCXXAcceptsFlag
+# ------------------
#
-# Macro CHECK_CXX_ACCEPTS_FLAG(FLAGS VARIABLE) -
-# checks if the function exists
-# FLAGS - the flags to try
-# VARIABLE - variable to store the result
+# Deprecated. See :module:`CheckCXXCompilerFlag`.
#
-
-#=============================================================================
-# Copyright 2002-2009 Kitware, Inc.
+# Check if the CXX compiler accepts a flag.
+#
+# .. code-block:: cmake
#
-# Distributed under the OSI-approved BSD License (the "License");
-# see accompanying file Copyright.txt for details.
+# CHECK_CXX_ACCEPTS_FLAG(<flags> <variable>)
#
-# This software is distributed WITHOUT ANY WARRANTY; without even the
-# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-# See the License for more information.
-#=============================================================================
-# (To distribute this file outside of CMake, substitute the full
-# License text for the above reference.)
+# ``<flags>``
+# the flags to try
+# ``<variable>``
+# variable to store the result
macro(CHECK_CXX_ACCEPTS_FLAG FLAGS VARIABLE)
if(NOT DEFINED ${VARIABLE})