diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2018-10-22 10:31:08 -0400 |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-10-22 11:09:34 -0400 |
| commit | df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56 (patch) | |
| tree | 4617dc2407a2e8e9c2bfdf77f09bdd396a9823e0 /Modules/CMakeFindPackageMode.cmake | |
| parent | 7115aa6c2249ec368fe0dfbd257a22eb0e04042d (diff) | |
| download | cmake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.gz | |
Help: Convert remaining modules to block-style comments
Diffstat (limited to 'Modules/CMakeFindPackageMode.cmake')
| -rw-r--r-- | Modules/CMakeFindPackageMode.cmake | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/Modules/CMakeFindPackageMode.cmake b/Modules/CMakeFindPackageMode.cmake index ec3652cfa2..815dfc90d8 100644 --- a/Modules/CMakeFindPackageMode.cmake +++ b/Modules/CMakeFindPackageMode.cmake @@ -1,33 +1,34 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# CMakeFindPackageMode -# -------------------- -# -# -# -# This file is executed by cmake when invoked with --find-package. It -# expects that the following variables are set using -D: -# -# ``NAME`` -# name of the package -# ``COMPILER_ID`` -# the CMake compiler ID for which the result is, -# i.e. GNU/Intel/Clang/MSVC, etc. -# ``LANGUAGE`` -# language for which the result will be used, -# i.e. C/CXX/Fortran/ASM -# ``MODE`` -# ``EXIST`` -# only check for existence of the given package -# ``COMPILE`` -# print the flags needed for compiling an object file which uses -# the given package -# ``LINK`` -# print the flags needed for linking when using the given package -# ``QUIET`` -# if TRUE, don't print anything +#[=======================================================================[.rst: +CMakeFindPackageMode +-------------------- + + + +This file is executed by cmake when invoked with --find-package. It +expects that the following variables are set using -D: + +``NAME`` + name of the package +``COMPILER_ID`` + the CMake compiler ID for which the result is, + i.e. GNU/Intel/Clang/MSVC, etc. +``LANGUAGE`` + language for which the result will be used, + i.e. C/CXX/Fortran/ASM +``MODE`` + ``EXIST`` + only check for existence of the given package + ``COMPILE`` + print the flags needed for compiling an object file which uses + the given package + ``LINK`` + print the flags needed for linking when using the given package +``QUIET`` + if TRUE, don't print anything +#]=======================================================================] if(NOT NAME) message(FATAL_ERROR "Name of the package to be searched not specified. Set the CMake variable NAME, e.g. -DNAME=JPEG .") |