diff options
| author | Brad King <brad.king@kitware.com> | 2013-12-19 15:41:17 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-12-19 15:41:40 (GMT) |
| commit | 95c705a6a90df796e08dd88759015ca0189bd689 (patch) | |
| tree | ebe0221baffbf0879b0030186b410864c0ce4535 /Modules | |
| parent | b375c18b9ea256e2e9a05fd8465c6d90b86b6f5b (diff) | |
| download | CMake-95c705a6a90df796e08dd88759015ca0189bd689.zip CMake-95c705a6a90df796e08dd88759015ca0189bd689.tar.gz CMake-95c705a6a90df796e08dd88759015ca0189bd689.tar.bz2 | |
TestCXXAcceptsFlag: Update documentation (#14657)
Document this module as deprecated and link to CheckCXXCompilerFlag.
Fix cut-n-paste-o and format macro signature.
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/TestCXXAcceptsFlag.cmake | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/Modules/TestCXXAcceptsFlag.cmake b/Modules/TestCXXAcceptsFlag.cmake index 2bcbea6..c814187 100644 --- a/Modules/TestCXXAcceptsFlag.cmake +++ b/Modules/TestCXXAcceptsFlag.cmake @@ -2,16 +2,18 @@ # TestCXXAcceptsFlag # ------------------ # -# Test CXX compiler for a flag +# Deprecated. See :module:`CheckCXXCompilerFlag`. # -# Check if the CXX compiler accepts a flag +# Check if the CXX compiler accepts a flag. # -# :: +# .. code-block:: cmake # -# Macro CHECK_CXX_ACCEPTS_FLAG(FLAGS VARIABLE) - -# checks if the function exists -# FLAGS - the flags to try -# VARIABLE - variable to store the result +# CHECK_CXX_ACCEPTS_FLAG(<flags> <variable>) +# +# ``<flags>`` +# the flags to try +# ``<variable>`` +# variable to store the result #============================================================================= # Copyright 2002-2009 Kitware, Inc. |