From d2689c95a1591fd7bc5bc8a2f1515a2db1d88b72 Mon Sep 17 00:00:00 2001 From: Ken Martin Date: Thu, 15 Dec 2005 10:41:19 -0500 Subject: ENH: some style fixes for the book --- Modules/CMakeBackwardCompatibilityCXX.cmake | 2 +- Modules/CMakeExportBuildSettings.cmake | 4 ++-- Modules/CMakeImportBuildSettings.cmake | 8 ++++---- Modules/CheckCXXSourceCompiles.cmake | 6 +++--- Modules/CheckIncludeFile.cmake | 2 +- Modules/CheckIncludeFileCXX.cmake | 5 +++-- Modules/CheckIncludeFiles.cmake | 4 ++-- Modules/CheckLibraryExists.cmake | 4 ++-- Modules/CheckSymbolExists.cmake | 6 +++--- Modules/CheckTypeSize.cmake | 2 +- Modules/CheckVariableExists.cmake | 6 +++--- Modules/FindAVIFile.cmake | 9 +++++---- Modules/FindCABLE.cmake | 8 +++++--- Modules/FindFLTK.cmake | 10 +++++----- Modules/FindGLUT.cmake | 2 +- Modules/FindGTK.cmake | 4 ++-- Modules/FindHTMLHelp.cmake | 6 +++--- Modules/FindITK.cmake | 28 ++++++++++++++-------------- Modules/FindImageMagick.cmake | 15 ++++++++++----- Modules/FindJNI.cmake | 6 +++--- Modules/FindJPEG.cmake | 2 +- Modules/FindJava.cmake | 6 +++--- Modules/FindLATEX.cmake | 14 +++++++------- Modules/FindMatlab.cmake | 10 +++++----- 24 files changed, 89 insertions(+), 80 deletions(-) diff --git a/Modules/CMakeBackwardCompatibilityCXX.cmake b/Modules/CMakeBackwardCompatibilityCXX.cmake index 9a2508c..c6eead1 100644 --- a/Modules/CMakeBackwardCompatibilityCXX.cmake +++ b/Modules/CMakeBackwardCompatibilityCXX.cmake @@ -1,4 +1,4 @@ -# - define a bunch of backwards compatibility varibles +# - define a bunch of backwards compatibility variables # CMAKE_ANSI_CXXFLAGS - flag for ansi c++ # CMAKE_HAS_ANSI_STRING_STREAM - has # INCLUDE(TestForANSIStreamHeaders) diff --git a/Modules/CMakeExportBuildSettings.cmake b/Modules/CMakeExportBuildSettings.cmake index d24f28c..0c71efa 100644 --- a/Modules/CMakeExportBuildSettings.cmake +++ b/Modules/CMakeExportBuildSettings.cmake @@ -1,6 +1,6 @@ # - export build settings from a project. -# CMAKE_EXPORT_BUILD_SETTINGS(SETTINGS_FILE) - macro defined to export the build -# settings for use by another project. +# CMAKE_EXPORT_BUILD_SETTINGS(SETTINGS_FILE) +# macro defined to export the build settings for use by another project. # SETTINGS_FILE - the file into which the settings are to be stored. MACRO(CMAKE_EXPORT_BUILD_SETTINGS SETTINGS_FILE) IF(${SETTINGS_FILE} MATCHES ".+") diff --git a/Modules/CMakeImportBuildSettings.cmake b/Modules/CMakeImportBuildSettings.cmake index e3f0731..8d77aca 100644 --- a/Modules/CMakeImportBuildSettings.cmake +++ b/Modules/CMakeImportBuildSettings.cmake @@ -1,8 +1,8 @@ # - import build settings from another project -# CMAKE_IMPORT_BUILD_SETTINGS(SETTINGS_FILE) - macro defined to import the -# build settings from another project. -# SETTINGS_FILE - a file created by the other project's call to the -# CMAKE_EXPORT_BUILD_SETTINGS macro, see CMakeExportBuildSettings. +# CMAKE_IMPORT_BUILD_SETTINGS(SETTINGS_FILE) +# macro defined to import the build settings from another project. +# SETTINGS_FILE is a file created by the other project's call to the +# CMAKE_EXPORT_BUILD_SETTINGS macro, see CMakeExportBuildSettings. MACRO(CMAKE_IMPORT_BUILD_SETTINGS SETTINGS_FILE) IF(${SETTINGS_FILE} MATCHES ".+") # Load the settings. diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index bbbc98e..a9e0ef1 100644 --- a/Modules/CheckCXXSourceCompiles.cmake +++ b/Modules/CheckCXXSourceCompiles.cmake @@ -1,11 +1,11 @@ # - Check if the source code provided in the SOURCE argument compiles. # CHECK_CXX_SOURCE_COMPILES(SOURCE VAR) # - macro which checks if the source code compiles\ -# SOURCE - source code to try to compile -# VAR - variable to store size if the type exists. +# SOURCE - source code to try to compile +# VAR - variable to store size if the type exists. # Checks the following optional VARIABLES (not arguments) # CMAKE_REQUIRED_LIBRARIES - Link to extra libraries -# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler +# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler # MACRO(CHECK_CXX_SOURCE_COMPILES SOURCE VAR) diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake index 206ff93..462302c 100644 --- a/Modules/CheckIncludeFile.cmake +++ b/Modules/CheckIncludeFile.cmake @@ -1,7 +1,7 @@ # - Check if the include file exists. # CHECK_INCLUDE_FILE(INCLUDE VARIABLE) # - macro which checks the include file exists. -# INCLUDE - name of include file +# INCLUDE - name of include file # VARIABLE - variable to return result # # an optional third argument is the CFlags to add to the compile line diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake index 8fd79c9..588f30b 100644 --- a/Modules/CheckIncludeFileCXX.cmake +++ b/Modules/CheckIncludeFileCXX.cmake @@ -1,6 +1,7 @@ # - Check if the include file exists. -# CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE) - macro which checks the include file exists. -# INCLUDE - name of include file +# CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE) +# +# INCLUDE - name of include file # VARIABLE - variable to return result # # An optional third argument is the CFlags to add to the compile line diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake index 79ba337..7e94593 100644 --- a/Modules/CheckIncludeFiles.cmake +++ b/Modules/CheckIncludeFiles.cmake @@ -1,8 +1,8 @@ # - Check if the files can be included # # CHECK_INCLUDE_FILES(INCLUDE VARIABLE) -# - macro which checks the include file exists. -# INCLUDE - list of files to include +# +# INCLUDE - list of files to include # VARIABLE - variable to return result # # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake index fde1ca1..822c3f3 100644 --- a/Modules/CheckLibraryExists.cmake +++ b/Modules/CheckLibraryExists.cmake @@ -1,7 +1,7 @@ # - Check if the function exists. # CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE) -# - macro which checks if the function exists -# LIBRARY - the name of the library you are looking for +# +# LIBRARY - the name of the library you are looking for # FUNCTION - the name of the function # LOCATION - location where the library should be found # VARIABLE - variable to store the result diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index 6d965fb..c0f0698 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -1,8 +1,8 @@ # - Check if the symbol exists in include files # CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE) -# - macro which checks the symbol exists in include files. -# SYMBOL - symbol -# FILES - include files to check +# +# SYMBOL - symbol +# FILES - include files to check # VARIABLE - variable to return result # # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the diff --git a/Modules/CheckTypeSize.cmake b/Modules/CheckTypeSize.cmake index e19c260..da2b4ed 100644 --- a/Modules/CheckTypeSize.cmake +++ b/Modules/CheckTypeSize.cmake @@ -1,5 +1,5 @@ # - Check sizeof a type -# CHECK_TYPE_SIZE(TYPE VARIABLE) +# CHECK_TYPE_SIZE(TYPE VARIABLE) # Check if the type exists and determine size of type. if the type # exists, the size will be stored to the variable. # diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake index 1cebdee..97413f4 100644 --- a/Modules/CheckVariableExists.cmake +++ b/Modules/CheckVariableExists.cmake @@ -1,7 +1,7 @@ # - Check if the variable exists. -# CHECK_VARIABLE_EXISTS(VAR VARIABLE) -# - macro which checks if the variable exists -# VAR - the name of the variable +# CHECK_VARIABLE_EXISTS(VAR VARIABLE) +# +# VAR - the name of the variable # VARIABLE - variable to store the result # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then diff --git a/Modules/FindAVIFile.cmake b/Modules/FindAVIFile.cmake index 6c4be04..f393bc3 100644 --- a/Modules/FindAVIFile.cmake +++ b/Modules/FindAVIFile.cmake @@ -1,12 +1,13 @@ # - Locate AVIFILE library and include paths -# AVIFILE (http://avifile.sourceforge.net/)is a set of library for i386 machines +# AVIFILE (http://avifile.sourceforge.net/)is a set of libraries for +# i386 machines # to use various AVI codecs. Support is limited beyond Linux. Windows # provides native AVI support, and so doesn't need this library. # This module defines # AVIFILE_INCLUDE_DIR, where to find avifile.h , etc. -# AVIFILE_LIBRARIES, the libraries to link against to use AVIFILE -# AVIFILE_DEFINITIONS, definitions to use when compiling code that uses AVIFILE. -# AVIFILE_FOUND, If false, don't try to use AVIFILE. +# AVIFILE_LIBRARIES, the libraries to link against +# AVIFILE_DEFINITIONS, definitions to use when compiling +# AVIFILE_FOUND, If false, don't try to use AVIFILE IF (UNIX) diff --git a/Modules/FindCABLE.cmake b/Modules/FindCABLE.cmake index f7ceaaa..5bcbc67 100644 --- a/Modules/FindCABLE.cmake +++ b/Modules/FindCABLE.cmake @@ -1,9 +1,11 @@ # - Find CABLE # This module finds if CABLE is installed and determines where the # include files and libraries are. This code sets the following variables: -# CABLE = the full path to the cable executable -# CABLE_TCL_LIBRARY = the full path to the Tcl wrapper facility library -# CABLE_INCLUDE_DIR = the full path to the cable include directory +# +# CABLE the path to the cable executable +# CABLE_TCL_LIBRARY the path to the Tcl wrapper library +# CABLE_INCLUDE_DIR the path to the include directory +# # To build Tcl wrappers, you should add shared library and link it to # ${CABLE_TCL_LIBRARY}. You should also add ${CABLE_INCLUDE_DIR} as # an include directory. diff --git a/Modules/FindFLTK.cmake b/Modules/FindFLTK.cmake index df93e57..d16cf73 100644 --- a/Modules/FindFLTK.cmake +++ b/Modules/FindFLTK.cmake @@ -1,15 +1,15 @@ # - Find the native FLTK includes and library # The following settings are defined # FLTK_FLUID_EXECUTABLE, where to find the Fluid tool -# FLTK_WRAP_UI, This allows the FLTK_WRAP_UI command to work. +# FLTK_WRAP_UI, This enables the FLTK_WRAP_UI command # FLTK_INCLUDE_DIR, where to find include files # FLTK_LIBRARIES, list of fltk libraries # FLTK_FOUND, Don't use FLTK if false. # The following settings should not be used in general. -# FLTK_BASE_LIBRARY = the full path to fltk.lib -# FLTK_GL_LIBRARY = the full path to fltk_gl.lib -# FLTK_FORMS_LIBRARY = the full path to fltk_forms.lib -# FLTK_IMAGES_LIBRARY = the full path to fltk_images.lib +# FLTK_BASE_LIBRARY = the full path to fltk.lib +# FLTK_GL_LIBRARY = the full path to fltk_gl.lib +# FLTK_FORMS_LIBRARY = the full path to fltk_forms.lib +# FLTK_IMAGES_LIBRARY = the full path to fltk_images.lib # Platform dependent libraries required by FLTK IF(WIN32) diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake index 449d34e..e88a55f 100644 --- a/Modules/FindGLUT.cmake +++ b/Modules/FindGLUT.cmake @@ -1,6 +1,6 @@ # - try to find glut library and include files # GLUT_INCLUDE_DIR, where to find GL/glut.h, etc. -# GLUT_LIBRARIES, the libraries to link against to use GLUT. +# GLUT_LIBRARIES, the libraries to link against # GLUT_FOUND, If false, do not try to use GLUT. # Also defined, but not for general use are: # GLUT_glut_LIBRARY = the full path to the glut library. diff --git a/Modules/FindGTK.cmake b/Modules/FindGTK.cmake index 6d0c203..b3cbe50 100644 --- a/Modules/FindGTK.cmake +++ b/Modules/FindGTK.cmake @@ -1,8 +1,8 @@ # - try to find GTK (and glib) and GTKGLArea # GTK_INCLUDE_DIR - Directories to include to use GTK # GTK_LIBRARIES - Files to link against to use GTK -# GTK_FOUND - If false, don't try to use GTK -# GTK_GL_FOUND - If false, don't try to use GTK's GL features +# GTK_FOUND - GTK was found +# GTK_GL_FOUND - GTK's GL features were found # don't even bother under WIN32 IF(UNIX) diff --git a/Modules/FindHTMLHelp.cmake b/Modules/FindHTMLHelp.cmake index 9bb6ff5..30d4467 100644 --- a/Modules/FindHTMLHelp.cmake +++ b/Modules/FindHTMLHelp.cmake @@ -1,8 +1,8 @@ # - This module looks for Microsoft HTML Help Compiler # It defines: -# HTML_HELP_COMPILER - path to the HTML Help Compiler (hhc.exe) -# HTML_HELP_INCLUDE_PATH - include path for HTML Help API (htmlhelp.h) -# HTML_HELP_LIBRARY - path to the HTML Help library (htmlhelp.lib) +# HTML_HELP_COMPILER - path to the Compiler hhc.exe +# HTML_HELP_INCLUDE_PATH - include path for htmlhelp.h +# HTML_HELP_LIBRARY - path to the library htmlhelp.lib # IF (WIN32) diff --git a/Modules/FindITK.cmake b/Modules/FindITK.cmake index 2612bd6..2e2b034 100644 --- a/Modules/FindITK.cmake +++ b/Modules/FindITK.cmake @@ -1,24 +1,24 @@ # - Find an ITK installation or build tree. + # When ITK is found, the ITKConfig.cmake file is sourced to setup the # location and configuration of ITK. Please read this file, or # ITKConfig.cmake.in from the ITK source tree for the full list of -# definitions. Of particular interest is -# -# ITK_USE_FILE - A CMake source file that can be included -# to set the include directories, library -# directories, and preprocessor macros. -# In addition to the variables read from ITKConfig.cmake, this find -# module also defines -# ITK_DIR - The directory containing ITKConfig.cmake. This is -# either the root of the build tree, or the -# lib/InsightToolkit directory. This is the only -# cache entry. +# definitions. Of particular interest is ITK_USE_FILE, a CMake source file +# that can be included to set the include directories, library directories, +# and preprocessor macros. In addition to the variables read from +# ITKConfig.cmake, this find module also defines +# ITK_DIR - The directory containing ITKConfig.cmake. +# This is either the root of the build tree, +# or the lib/InsightToolkit directory. +# This is the only cache entry. # -# ITK_FOUND - Whether ITK was found. If this is true, ITK_DIR is okay. +# ITK_FOUND - Whether ITK was found. If this is true, +# ITK_DIR is okay. # # USE_ITK_FILE - The full path to the UseITK.cmake file. -# This is provided for backward compatability. -# Use ITK_USE_FILE instead. +# This is provided for backward +# compatability. Use ITK_USE_FILE +# instead. SET(ITK_DIR_STRING "directory containing ITKConfig.cmake. This is either the root of the build tree, or PREFIX/lib/InsightToolkit for an installation.") diff --git a/Modules/FindImageMagick.cmake b/Modules/FindImageMagick.cmake index ab6f0b6..66e54bc 100644 --- a/Modules/FindImageMagick.cmake +++ b/Modules/FindImageMagick.cmake @@ -2,11 +2,16 @@ # This module finds if ImageMagick tools are installed and determines # where the executables are. This code sets the following variables: # -# IMAGEMAGICK_CONVERT_EXECUTABLE = the full path to the 'convert' utility -# IMAGEMAGICK_MOGRIFY_EXECUTABLE = the full path to the 'mogrify' utility -# IMAGEMAGICK_IMPORT_EXECUTABLE = the full path to the 'import' utility -# IMAGEMAGICK_MONTAGE_EXECUTABLE = the full path to the 'montage' utility -# IMAGEMAGICK_COMPOSITE_EXECUTABLE = the full path to the 'composite' utility +# IMAGEMAGICK_CONVERT_EXECUTABLE = +# the full path to the 'convert' utility +# IMAGEMAGICK_MOGRIFY_EXECUTABLE = +# the full path to the 'mogrify' utility +# IMAGEMAGICK_IMPORT_EXECUTABLE = +# the full path to the 'import' utility +# IMAGEMAGICK_MONTAGE_EXECUTABLE = +# the full path to the 'montage' utility +# IMAGEMAGICK_COMPOSITE_EXECUTABLE = +# the full path to the 'composite' utility # IF (WIN32) diff --git a/Modules/FindJNI.cmake b/Modules/FindJNI.cmake index 8d32ecd..4fdbb28 100644 --- a/Modules/FindJNI.cmake +++ b/Modules/FindJNI.cmake @@ -3,9 +3,9 @@ # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: # -# JAVA_AWT_LIB_PATH = the path to where the jawt library is -# JAVA_INCLUDE_PATH = the path to where jni.h can be found -# JAVA_AWT_INCLUDE_PATH = the path to where jawt.h can be found +# JAVA_AWT_LIB_PATH = the path to the jawt library +# JAVA_INCLUDE_PATH = the include path to jni.h +# JAVA_AWT_INCLUDE_PATH = the include path to jawt.h # SET(JAVA_AWT_LIBRARY_DIRECTORIES diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake index c5cd90f..5bf1ae6 100644 --- a/Modules/FindJPEG.cmake +++ b/Modules/FindJPEG.cmake @@ -2,7 +2,7 @@ # Find the native JPEG includes and library # This module defines # JPEG_INCLUDE_DIR, where to find jpeglib.h, etc. -# JPEG_LIBRARIES, the libraries to link against to use JPEG. +# JPEG_LIBRARIES, the libraries needed to use JPEG. # JPEG_FOUND, If false, do not try to use JPEG. # also defined, but not for general use are # JPEG_LIBRARY, where to find the JPEG library. diff --git a/Modules/FindJava.cmake b/Modules/FindJava.cmake index 3ec18da..5f7f6ff 100644 --- a/Modules/FindJava.cmake +++ b/Modules/FindJava.cmake @@ -3,9 +3,9 @@ # include files and libraries are. This code sets the following # variables: # -# JAVA_RUNTIME = the full path to the Java runtime -# JAVA_COMPILE = the full path to the Java compiler -# JAVA_ARCHIVE = the full path to the Java archiver +# JAVA_RUNTIME = the full path to the Java runtime +# JAVA_COMPILE = the full path to the Java compiler +# JAVA_ARCHIVE = the full path to the Java archiver # SET(JAVA_BIN_PATH "[HKEY_LOCAL_MACHINE\\SOFTWARE\\JavaSoft\\Java Development Kit\\2.0;JavaHome]/bin" diff --git a/Modules/FindLATEX.cmake b/Modules/FindLATEX.cmake index d7e37e3..a02d9e1 100644 --- a/Modules/FindLATEX.cmake +++ b/Modules/FindLATEX.cmake @@ -2,13 +2,13 @@ # This module finds if Latex is installed and determines where the # executables are. This code sets the following variables: # -# LATEX_COMPILER = the full path to the LaTeX compiler -# PDFLATEX_COMPILER = the full path to the PdfLaTeX compiler -# BIBTEX_COMPILER = the full path to the BibTeX compiler -# MAKEINDEX_COMPILER = the full path to the MakeIndex compiler -# DVIPS_CONVERTER = the full path to the DVIPS converter -# PS2PDF_CONVERTER = the full path to the PS2PDF converter -# LATEX2HTML_CONVERTER = the full path to the LaTeX2Html converter +# LATEX_COMPILER: path to the LaTeX compiler +# PDFLATEX_COMPILER: path to the PdfLaTeX compiler +# BIBTEX_COMPILER: path to the BibTeX compiler +# MAKEINDEX_COMPILER: path to the MakeIndex compiler +# DVIPS_CONVERTER: path to the DVIPS converter +# PS2PDF_CONVERTER: path to the PS2PDF converter +# LATEX2HTML_CONVERTER: path to the LaTeX2Html converter # IF (WIN32) diff --git a/Modules/FindMatlab.cmake b/Modules/FindMatlab.cmake index 09fe88a..17e6f36 100644 --- a/Modules/FindMatlab.cmake +++ b/Modules/FindMatlab.cmake @@ -1,10 +1,10 @@ # - this module looks for Matlab # Defines: -# MATLAB_INCLUDE_DIR points to the include path for mex.h, engine.h -# MATLAB_LIBRARIES list of libraries need: libmex.lib, libmx.lib and libeng.lib -# MATLAB_MEX_LIBRARY point to libmex.lib -# MATLAB_MX_LIBRARY point to libmx.lib -# MATLAB_ENG_LIBRARY point to libeng.lib +# MATLAB_INCLUDE_DIR: include path for mex.h, engine.h +# MATLAB_LIBRARIES: required libraries: libmex, etc +# MATLAB_MEX_LIBRARY: path to libmex.lib +# MATLAB_MX_LIBRARY: path to libmx.lib +# MATLAB_ENG_LIBRARY: path to libeng.lib SET(MATLAB_FOUND 0) -- cgit v0.12