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/SelectLibraryConfigurations.cmake | |
| parent | 7115aa6c2249ec368fe0dfbd257a22eb0e04042d (diff) | |
| download | cmake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.gz | |
Help: Convert remaining modules to block-style comments
Diffstat (limited to 'Modules/SelectLibraryConfigurations.cmake')
| -rw-r--r-- | Modules/SelectLibraryConfigurations.cmake | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/Modules/SelectLibraryConfigurations.cmake b/Modules/SelectLibraryConfigurations.cmake index fe3bb00a68..8cb714d072 100644 --- a/Modules/SelectLibraryConfigurations.cmake +++ b/Modules/SelectLibraryConfigurations.cmake @@ -1,31 +1,32 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# SelectLibraryConfigurations -# --------------------------- -# -# -# -# select_library_configurations( basename ) -# -# This macro takes a library base name as an argument, and will choose -# good values for basename_LIBRARY, basename_LIBRARIES, -# basename_LIBRARY_DEBUG, and basename_LIBRARY_RELEASE depending on what -# has been found and set. If only basename_LIBRARY_RELEASE is defined, -# basename_LIBRARY will be set to the release value, and -# basename_LIBRARY_DEBUG will be set to basename_LIBRARY_DEBUG-NOTFOUND. -# If only basename_LIBRARY_DEBUG is defined, then basename_LIBRARY will -# take the debug value, and basename_LIBRARY_RELEASE will be set to -# basename_LIBRARY_RELEASE-NOTFOUND. -# -# If the generator supports configuration types, then basename_LIBRARY -# and basename_LIBRARIES will be set with debug and optimized flags -# specifying the library to be used for the given configuration. If no -# build type has been set or the generator in use does not support -# configuration types, then basename_LIBRARY and basename_LIBRARIES will -# take only the release value, or the debug value if the release one is -# not set. +#[=======================================================================[.rst: +SelectLibraryConfigurations +--------------------------- + + + +select_library_configurations( basename ) + +This macro takes a library base name as an argument, and will choose +good values for basename_LIBRARY, basename_LIBRARIES, +basename_LIBRARY_DEBUG, and basename_LIBRARY_RELEASE depending on what +has been found and set. If only basename_LIBRARY_RELEASE is defined, +basename_LIBRARY will be set to the release value, and +basename_LIBRARY_DEBUG will be set to basename_LIBRARY_DEBUG-NOTFOUND. +If only basename_LIBRARY_DEBUG is defined, then basename_LIBRARY will +take the debug value, and basename_LIBRARY_RELEASE will be set to +basename_LIBRARY_RELEASE-NOTFOUND. + +If the generator supports configuration types, then basename_LIBRARY +and basename_LIBRARIES will be set with debug and optimized flags +specifying the library to be used for the given configuration. If no +build type has been set or the generator in use does not support +configuration types, then basename_LIBRARY and basename_LIBRARIES will +take only the release value, or the debug value if the release one is +not set. +#]=======================================================================] # This macro was adapted from the FindQt4 CMake module and is maintained by Will # Dicharry <wdicharry@stellarscience.com>. |