TestCXXAcceptsFlag: Update documentation (#14657)

Document this module as deprecated and link to CheckCXXCompilerFlag.
Fix cut-n-paste-o and format macro signature.
This commit is contained in:
Brad King 2013-12-19 10:41:17 -05:00
parent b375c18b9e
commit 95c705a6a9
1 changed files with 9 additions and 7 deletions

View File

@ -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.