diff options
| author | Bill Hoffman <bill.hoffman@kitware.com> | 2005-12-14 18:51:08 (GMT) |
|---|---|---|
| committer | Bill Hoffman <bill.hoffman@kitware.com> | 2005-12-14 18:51:08 (GMT) |
| commit | b7fa820118d6989ca4d77dbfcc972c2e903bfe2a (patch) | |
| tree | a5605c468a458597fff5f17485fad8cd85856e1b /Modules/FindVTK.cmake | |
| parent | 805d365d479a916acf2c5638809fb046fc28dc97 (diff) | |
| download | CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.zip CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.gz CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.bz2 | |
ENH: add documentation support for modules
Diffstat (limited to 'Modules/FindVTK.cmake')
| -rw-r--r-- | Modules/FindVTK.cmake | 42 |
1 files changed, 19 insertions, 23 deletions
diff --git a/Modules/FindVTK.cmake b/Modules/FindVTK.cmake index e5f7d79..23789e4 100644 --- a/Modules/FindVTK.cmake +++ b/Modules/FindVTK.cmake @@ -1,30 +1,26 @@ -# -# Find a VTK installation or build tree. -# +# - Find a VTK installation or build tree. # The following variables are set if VTK is found. If VTK is not # found, VTK_FOUND is set to false. -# -# VTK_FOUND - Set to true when VTK is found. -# VTK_USE_FILE - CMake source file to setup a project to use VTK. -# VTK_MAJOR_VERSION - The VTK major version number. -# VTK_MINOR_VERSION - The VTK minor version number (odd for non-release). -# VTK_BUILD_VERSION - The VTK patch level (meaningless for odd minor). -# VTK_INCLUDE_DIRS - Include directories for VTK headers. -# VTK_LIBRARY_DIRS - Link directories for VTK libraries. -# VTK_KITS - List of VTK kits, in all CAPS (COMMON, IO, ...). -# VTK_LANGUAGES - List of wrapped languages, in all CAPS (TCL, ...). -# +# VTK_FOUND - Set to true when VTK is found. +# VTK_USE_FILE - CMake file to setup a project to use VTK. +# VTK_MAJOR_VERSION - The VTK major version number. +# VTK_MINOR_VERSION - The VTK minor version number +# (odd non-release). +# VTK_BUILD_VERSION - The VTK patch level +# (meaningless for odd minor). +# VTK_INCLUDE_DIRS - Include directories for VTK headers. +# VTK_LIBRARY_DIRS - Link directories for VTK libraries. +# VTK_KITS - List of VTK kits, in CAPS (COMMON,IO,). +# VTK_LANGUAGES - List of wrapped languages, in CAPS (TCL,) # The following cache entries must be set by the user to locate VTK: -# -# VTK_DIR - The directory containing VTKConfig.cmake. This is either -# the root of the build tree, or the lib/vtk -# directory. This is the only cache entry. -# -# The following variables are set for backward compatability and +# VTK_DIR - The directory containing VTKConfig.cmake. This +# is either the root of the build tree, or the +# lib/vtk directory. This is the only cache entry. +# The following variables are set for backward compatibility and # should not be used in new code: -# -# USE_VTK_FILE - The full path to the UseVTK.cmake file. This is provided -# for backward compatability. Use VTK_USE_FILE instead. +# USE_VTK_FILE - The full path to the UseVTK.cmake file. This +# is provided for backward compatability. Use +# VTK_USE_FILE instead. # # Construct consitent error messages for use below. |