diff options
| author | Brad King <brad.king@kitware.com> | 2015-06-25 09:37:43 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-25 09:41:02 -0400 |
| commit | 81d58b0de62d3e1fdaeaf7029b0a415c32cf6b2a (patch) | |
| tree | b61643ddeb6b24db6a8b7495e3b69277e63b8a91 /Modules/CheckIncludeFiles.cmake | |
| parent | a6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff) | |
| download | cmake-81d58b0de62d3e1fdaeaf7029b0a415c32cf6b2a.tar.gz | |
Help: Revise CheckIncludeFile* documentation
Improve formatting. Link from each module to the other two. Explain
the command signatures in more detail.
Diffstat (limited to 'Modules/CheckIncludeFiles.cmake')
| -rw-r--r-- | Modules/CheckIncludeFiles.cmake | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake index 2494862457..843cd35ef7 100644 --- a/Modules/CheckIncludeFiles.cmake +++ b/Modules/CheckIncludeFiles.cmake @@ -2,29 +2,34 @@ # CheckIncludeFiles # ----------------- # -# Check if the files can be included +# Provides a macro to check if a list of one or more header files can +# be included together in ``C``. # +# .. command:: CHECK_INCLUDE_FILES # +# :: # -# CHECK_INCLUDE_FILES(INCLUDE VARIABLE) -# -# :: -# -# INCLUDE - list of files to include -# VARIABLE - variable to return result -# Will be created as an internal cache variable. -# +# CHECK_INCLUDE_FILES("<includes>" <variable>) # +# Check if the given ``<includes>`` list may be included together +# in a ``C`` source file and store the result in an internal cache +# entry named ``<variable>``. Specify the ``<includes>`` argument +# as a :ref:`;-list <CMake Language Lists>` of header file names. # # 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_QUIET`` +# execute quietly without messages # -# 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_QUIET = execute quietly without messages +# See modules :module:`CheckIncludeFile` and :module:`CheckIncludeFileCXX` +# to check for a single header file in ``C`` or ``CXX`` languages. #============================================================================= # Copyright 2003-2012 Kitware, Inc. |