diff options
author | Kitware Robot <kwrobot@kitware.com> | 2018-10-22 14:31:08 (GMT) |
---|---|---|
committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-10-22 15:09:34 (GMT) |
commit | df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56 (patch) | |
tree | 4617dc2407a2e8e9c2bfdf77f09bdd396a9823e0 /Modules/CheckIncludeFileCXX.cmake | |
parent | 7115aa6c2249ec368fe0dfbd257a22eb0e04042d (diff) | |
download | CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.zip CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.gz CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.bz2 |
Help: Convert remaining modules to block-style comments
Diffstat (limited to 'Modules/CheckIncludeFileCXX.cmake')
-rw-r--r-- | Modules/CheckIncludeFileCXX.cmake | 67 |
1 files changed, 34 insertions, 33 deletions
diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake index f13d983..42b5eaf 100644 --- a/Modules/CheckIncludeFileCXX.cmake +++ b/Modules/CheckIncludeFileCXX.cmake @@ -1,39 +1,40 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# CheckIncludeFileCXX -# ------------------- -# -# Provides a macro to check if a header file can be included in ``CXX``. -# -# .. command:: CHECK_INCLUDE_FILE_CXX -# -# :: -# -# CHECK_INCLUDE_FILE_CXX(<include> <variable> [<flags>]) -# -# Check if the given ``<include>`` file may be included in a ``CXX`` -# source file and store the result in an internal cache entry named -# ``<variable>``. The optional third argument may be used to add -# compilation flags to the check (or use ``CMAKE_REQUIRED_FLAGS`` below). -# -# The following variables may be set before calling this macro to modify -# the way the check is run: -# -# ``CMAKE_REQUIRED_FLAGS`` -# string of compile command line flags -# ``CMAKE_REQUIRED_DEFINITIONS`` -# list of macros to define (-DFOO=bar) -# ``CMAKE_REQUIRED_INCLUDES`` -# list of include directories -# ``CMAKE_REQUIRED_LIBRARIES`` -# A list of libraries to link. See policy :policy:`CMP0075`. -# ``CMAKE_REQUIRED_QUIET`` -# execute quietly without messages -# -# See modules :module:`CheckIncludeFile` and :module:`CheckIncludeFiles` -# to check for one or more ``C`` headers. +#[=======================================================================[.rst: +CheckIncludeFileCXX +------------------- + +Provides a macro to check if a header file can be included in ``CXX``. + +.. command:: CHECK_INCLUDE_FILE_CXX + + :: + + CHECK_INCLUDE_FILE_CXX(<include> <variable> [<flags>]) + + Check if the given ``<include>`` file may be included in a ``CXX`` + source file and store the result in an internal cache entry named + ``<variable>``. The optional third argument may be used to add + compilation flags to the check (or use ``CMAKE_REQUIRED_FLAGS`` below). + +The following variables may be set before calling this macro to modify +the way the check is run: + +``CMAKE_REQUIRED_FLAGS`` + string of compile command line flags +``CMAKE_REQUIRED_DEFINITIONS`` + list of macros to define (-DFOO=bar) +``CMAKE_REQUIRED_INCLUDES`` + list of include directories +``CMAKE_REQUIRED_LIBRARIES`` + A list of libraries to link. See policy :policy:`CMP0075`. +``CMAKE_REQUIRED_QUIET`` + execute quietly without messages + +See modules :module:`CheckIncludeFile` and :module:`CheckIncludeFiles` +to check for one or more ``C`` headers. +#]=======================================================================] include_guard(GLOBAL) |