diff options
| author | Brad King <brad.king@kitware.com> | 2003-02-14 18:47:16 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2003-02-14 18:47:16 -0500 |
| commit | a02574158d178615cf8fd642695e5099b6041049 (patch) | |
| tree | df9f52770e9c2ff771988ae1a91ec0b2287548da /Source | |
| parent | dec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff) | |
| download | cmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz | |
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source')
75 files changed, 612 insertions, 365 deletions
diff --git a/Source/cmAbstractFilesCommand.h b/Source/cmAbstractFilesCommand.h index 7a9167c73a..e709d4e23e 100644 --- a/Source/cmAbstractFilesCommand.h +++ b/Source/cmAbstractFilesCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Depricated command, see SET_SOURCE_FILES_PROPERTIES."; + return "Deprecated. See SET_SOURCE_FILES_PROPERTIES."; } /** @@ -53,7 +53,8 @@ public: virtual const char* GetFullDocumentation() { return - "ABSTRACT_FILES(file1 file2 ..)."; + " ABSTRACT_FILES(file1 file2 ...)\n" + "Marks files with the ABSTRACT property."; } cmTypeMacro(cmAbstractFilesCommand, cmCommand); diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h index b158ca31e0..a48bf15829 100644 --- a/Source/cmAddCustomCommandCommand.h +++ b/Source/cmAddCustomCommandCommand.h @@ -77,7 +77,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create new command within CMake."; + return "Add a custom build rule to the generated build system."; } /** @@ -86,24 +86,37 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_CUSTOM_COMMAND([SOURCE source] [COMMAND command] TARGET target " - "[ARGS [args...]] [DEPENDS [depends...]] [OUTPUTS [outputs...]] [COMMENT comment])\n" + " ADD_CUSTOM_COMMAND(TARGET target\n" + " [SOURCE source]\n" + " [COMMAND command]\n" + " [ARGS [args...]]\n" + " [DEPENDS [depends...]]\n" + " [OUTPUTS [outputs...]]\n" + " [COMMENT comment])\n" "This defines a new command that can be executed during the build " - "process. In makefile terms this creates a new target in the following form:<pre><code>\n" - "OUTPUT1: SOURCE DEPENDS\n" - " COMAND ARGS\n" - "OUTPUT2: SOURCE DEPENDS\n" - " COMAND ARGS\n" - " Example of usage:\n" + "process. In makefile terms this creates a new target in the " + "following form:\n" + " OUTPUT1: SOURCE DEPENDS\n" + " COMAND ARGS\n" + " OUTPUT2: SOURCE DEPENDS\n" + " COMAND ARGS\n" + "The TARGET must be specified, but it is not the make target of the " + "build rule. It is the target (library, executable, or custom target) " + "that will use the output generated from this rule. This is necessary " + "to choose a project file in which to generate the rule for Visual " + "Studio.\n\n" + "Example of usage:\n" " ADD_CUSTOM_COMMAND(\n" - " SOURCE ${VTK_TIFF_FAX_EXE} \n" - " COMMAND ${VTK_TIFF_FAX_EXE} \n" - " ARGS -c const ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c \n" - " TARGET vtktiff \n" - " OUTPUTS ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c\n" - " )\n" - "This will create custom target which will generate file tif_fax3sm.c\n" - "using command ${VTK_TIFF_FAX_EXE}.</pre></code>"; + " TARGET tiff\n" + " SOURCE ${TIFF_FAX_EXE}\n" + " COMMAND ${TIFF_FAX_EXE}\n" + " ARGS -c const ${TIFF_BINARY_DIR}/tif_fax3sm.c\n" + " OUTPUTS ${TIFF_BINARY_DIR}/tif_fax3sm.c\n" + " )\n" + "This will create custom target which will generate file tif_fax3sm.c " + "using command ${TIFF_FAX_EXE}. The rule will be executed as part of " + "building the tiff library because it includes tif_fax3sm.c as a " + "source file with the GENERATED property."; } cmTypeMacro(cmAddCustomCommandCommand, cmCommand); diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index 988fce5c08..37f8537f74 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -55,9 +55,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add an extra target to the build system that " - "does not produce output, so it" - " is run each time the target is built."; + return "Add a target with no output so it will always be built."; } /** @@ -66,8 +64,15 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n" - "If the ALL option is specified it indicates that this target should be added to the default build target. The command and arguments are optional. If not specified, it will create an empty target. The command cannot be called ALL."; + " ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n" + "Adds a target with the given name that executes the given command " + "every time the target is built. If the ALL option is specified " + "it indicates that this target should be added to the default build " + "target so that it will be run every time. " + "The command and arguments are optional. If not specified, " + "it will create an empty target. The ADD_DEPENDENCIES command can be " + "used in conjunction with this command to drive custom target " + "generation. The command cannot be called ALL."; } cmTypeMacro(cmAddCustomTargetCommand, cmCommand); diff --git a/Source/cmAddDefinitionsCommand.h b/Source/cmAddDefinitionsCommand.h index 2dfcf419ef..6d063d0200 100644 --- a/Source/cmAddDefinitionsCommand.h +++ b/Source/cmAddDefinitionsCommand.h @@ -59,7 +59,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add -D define flags to command line for environments."; + return "Adds -D define flags to the command line of C and C++ compilers."; } /** @@ -68,8 +68,11 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_DEFINITIONS(-DFOO -DBAR ...)\n" - "Add flags to command line of C and C++ compiles. This command can be used to add any flag to a compile line, but the -D flag is accepted most C/C++ compilers. Other flags may not be as portable."; + " ADD_DEFINITIONS(-DFOO -DBAR ...)\n" + "Adds flags to command line of C and C++ compilers. " + "This command can be used to add any flag to a compile line, " + "but the -D flag is accepted most C/C++ compilers. " + "Other flags may not be as portable."; } cmTypeMacro(cmAddDefinitionsCommand, cmCommand); diff --git a/Source/cmAddDependenciesCommand.h b/Source/cmAddDependenciesCommand.h index 5fcc7e84b8..5e9356a8a0 100644 --- a/Source/cmAddDependenciesCommand.h +++ b/Source/cmAddDependenciesCommand.h @@ -61,8 +61,12 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_DEPENDENCIES(target-name depend-target depend-target)\n" - "Add a dependency to a target. This is only used to add dependencies between one executable and another. Regular build dependencies are handled automatically."; + " ADD_DEPENDENCIES(target-name depend-target1\n" + " depend-target2 ...)\n" + "Add a dependency to a target. This is only used to add dependencies " + "between targets that cannot be inferred from the library/executable " + "links that are specified. Regular build dependencies are " + "handled automatically."; } cmTypeMacro(cmAddDependenciesCommand, cmCommand); diff --git a/Source/cmAddExecutableCommand.h b/Source/cmAddExecutableCommand.h index 07fc774f79..8844e920ff 100644 --- a/Source/cmAddExecutableCommand.h +++ b/Source/cmAddExecutableCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add an executable to the project that uses the specified source files."; + return "Add an executable to the project using the specified source files."; } /** @@ -62,10 +62,11 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_EXECUTABLE(exename [WIN32] source1 source2 ... sourceN)\n" - "This command adds an executable target to the current directory. " + " ADD_EXECUTABLE(exename [WIN32] source1\n" + " source2 ... sourceN)\n" + "This command adds an executable target to the current directory. " "The executable will be built from the list of source files " - "specified. The second argument to this command can be WIN32 " + "specified. The second argument to this command can be WIN32 " "which indicates that the executable (when compiled on windows) " "is a windows app (using WinMain) not a console app (using main)."; } diff --git a/Source/cmAddLibraryCommand.h b/Source/cmAddLibraryCommand.h index 19c929e7d2..e493526c14 100644 --- a/Source/cmAddLibraryCommand.h +++ b/Source/cmAddLibraryCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add an library to the project that uses the specified source files."; + return "Add an library to the project using the specified source files."; } /** @@ -62,13 +62,15 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_LIBRARY(libname [SHARED | STATIC | MODULE] source1 source2 ... sourceN)\n" - "Adds a library target. SHARED, STATIC or MODULE keywords are used\n" - "to set the library type. If the keywork MODULE appears, the library\n" - "type is set to MH_BUNDLE on systems which use dyld. Systems without\n" - "dyld MODULE is treated like SHARED. If no keywords appear as the second\n" - "argument, the type defaults to the current value of BUILD_SHARED_LIBS.\n" - "If this variable is not set, the type defaults to STATIC."; + " ADD_LIBRARY(libname [SHARED | STATIC | MODULE]\n" + " source1 source2 ... sourceN)\n" + "Adds a library target. SHARED, STATIC or MODULE keywords are used " + "to set the library type. If the keyword MODULE appears, the library " + "type is set to MH_BUNDLE on systems which use dyld. On systems " + "without dyld, MODULE is treated like SHARED. If no keywords appear " + " as the second argument, the type defaults to the current value of " + "BUILD_SHARED_LIBS. If this variable is not set, the type defaults " + "to STATIC."; } cmTypeMacro(cmAddLibraryCommand, cmCommand); diff --git a/Source/cmAddTestCommand.h b/Source/cmAddTestCommand.h index 2473013f8f..50dd7c9ce4 100644 --- a/Source/cmAddTestCommand.h +++ b/Source/cmAddTestCommand.h @@ -67,12 +67,12 @@ public: virtual const char* GetFullDocumentation() { return - "ADD_TEST(testname Exename arg1 arg2 arg3 ...)\n" - "If the ENABLE_TESTING command has been run, this command adds a" - "test target to the current directory. If ENABLE_TESTING has not" - "been run, this command does nothing.\n" + " ADD_TEST(testname Exename arg1 arg2 ...)\n" + "If the ENABLE_TESTING command has been run, this command adds a " + "test target to the current directory. If ENABLE_TESTING has not " + "been run, this command does nothing. " "The tests are run by the testing subsystem by executing Exename " - "with the specified arguments. Exename can be either an executable " + "with the specified arguments. Exename can be either an executable " "built by built by this project or an arbitrary executable on the " "system (like tclsh)."; } diff --git a/Source/cmAuxSourceDirectoryCommand.h b/Source/cmAuxSourceDirectoryCommand.h index 18bac9bd98..2da7d5e0d9 100644 --- a/Source/cmAuxSourceDirectoryCommand.h +++ b/Source/cmAuxSourceDirectoryCommand.h @@ -56,8 +56,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add all the source files found in the specified\n" - "directory to the variable name specified."; + return "Find all source files in a directory."; } /** @@ -66,7 +65,9 @@ public: virtual const char* GetFullDocumentation() { return - "AUX_SOURCE_DIRECTORY(dir VARIABLE)"; + " AUX_SOURCE_DIRECTORY(dir VARIABLE)\n" + "Collects the names of all the source files in the specified " + "directory and stores the list in the variable provided."; } cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand); diff --git a/Source/cmBuildCommand.h b/Source/cmBuildCommand.h index 927560410b..56d5d3265c 100644 --- a/Source/cmBuildCommand.h +++ b/Source/cmBuildCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Determine the command line that will build this project."; + return "Get the command line that will build this project."; } /** @@ -67,8 +67,12 @@ public: virtual const char* GetFullDocumentation() { return - "BUILD_COMMAND(NAME MAKECOMMAND)\n" - "Within CMAKE set NAME to the command that will build this project from the command line using MAKECOMMAND. MAKECOMMAND should be msdev, nmake, make or one of the end use build tools. This command will construct the command line to use that will build all the targets in this project. This is useful for testing systems."; + " BUILD_COMMAND(variable MAKECOMMAND)\n" + "Sets the given variable to a string containing the command that " + "will build this project from the root of the build tree using the " + "build tool given by MAKECOMMAND. MAKECOMMAND should be msdev, " + "nmake, make or one of the end user build tools. " + "This is useful for configuring testing systems."; } cmTypeMacro(cmBuildCommand, cmCommand); diff --git a/Source/cmBuildNameCommand.h b/Source/cmBuildNameCommand.h index 43f812e746..7f331e88fd 100644 --- a/Source/cmBuildNameCommand.h +++ b/Source/cmBuildNameCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Depricated command. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead.."; + return "Depricated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead."; } /** @@ -67,8 +67,10 @@ public: virtual const char* GetFullDocumentation() { return - "BUILD_NAME(NAME)\n" - "Within CMAKE sets NAME to the build type."; + " BUILD_NAME(variable)\n" + "Sets the specified variable to a string representing the platform " + "and compiler settings. These values are now available through the " + "CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables."; } cmTypeMacro(cmBuildNameCommand, cmCommand); diff --git a/Source/cmConfigureFileCommand.h b/Source/cmConfigureFileCommand.h index 9e19a6f5ba..d6d768f969 100644 --- a/Source/cmConfigureFileCommand.h +++ b/Source/cmConfigureFileCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create a file from an autoconf style file.in file."; + return "Copy a file to another location and modify its contents."; } /** @@ -53,19 +53,21 @@ public: virtual const char* GetFullDocumentation() { return - "CONFIGURE_FILE(InputFile OutputFile [COPYONLY] [ESCAPE_QUOTES] [IMMEDIATE] [@ONLY])\n" - "The Input and Ouput files have to have full paths.\n" - "They can also use variables like CMAKE_BINARY_DIR,CMAKE_SOURCE_DIR. " - "This command replaces any variables in the input file with their " - "values as determined by CMake. If a variables in not defined, it " - "will be replaced with nothing. If COPYONLY is passed in, then " - "then no variable expansion will take place. If ESCAPE_QUOTES is " - "passed in then any substitued quotes will be C style escaped. " + " CONFIGURE_FILE(InputFile OutputFile\n" + " [COPYONLY] [ESCAPE_QUOTES]\n" + " [IMMEDIATE] [@ONLY])\n" + "The Input and Ouput files have to have full paths. " + "This command replaces any variables in the input file referenced as " + "${VAR} or @VAR@ with their values as determined by CMake. If a " + "variable is not defined, it will be replaced with nothing. " + "If COPYONLY is specified, then then no variable expansion will take " + "place. If ESCAPE_QUOTES is specified in then any substitued quotes " + "will be C-style escaped. " "If IMMEDIATE is specified, then the file will be configured with " "the current values of CMake variables instead of waiting until the " - "end of CMakeLists processing. If @ONLY is present, only variables " - "of the form @var@ will be replaces and ${var} will be ignored. " - "This is useful for configuring tcl scripts that use ${var}."; + "end of CMakeLists processing. If @ONLY is specified, only variables " + "of the form @VAR@ will be replaces and ${VAR} will be ignored. " + "This is useful for configuring tcl scripts that use ${VAR}."; } virtual void FinalPass(); diff --git a/Source/cmCreateTestSourceList.h b/Source/cmCreateTestSourceList.h index 81b9a08d78..f85dc6b60e 100644 --- a/Source/cmCreateTestSourceList.h +++ b/Source/cmCreateTestSourceList.h @@ -67,10 +67,16 @@ public: virtual const char* GetFullDocumentation() { return - "CREATE_TEST_SOURCELIST(SourceListName DriverName test1 test2 test3 " - "EXTRA_INCLUDE include.h FUNCTION function) The list of source files " - "needed to build the testdriver will be in SourceListName. " - "DriverName is the name of the test driver program. The rest of " + " CREATE_TEST_SOURCELIST(SourceListName DriverName\n" + " test1 test2 test3\n" + " EXTRA_INCLUDE include.h\n" + " FUNCTION function)\n" + "A test driver is a program that links together many small tests into " + "a single executable. This is useful when building static executables " + "with large libraries to shrink the total required size. " + "The list of source files " + "needed to build the testdriver will be in SourceListName. " + "DriverName is the name of the test driver program. The rest of " "the arguments consist of a list of test source files, can be " "; separated. Each test source file should have a function in it that " "is the same name as the file with no extension (foo.cxx should have " diff --git a/Source/cmElseCommand.h b/Source/cmElseCommand.h index 4c5b42a773..45d7b39306 100644 --- a/Source/cmElseCommand.h +++ b/Source/cmElseCommand.h @@ -57,7 +57,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "starts the else portion of an if block"; + return "Starts the ELSE portion of an IF block."; } /** @@ -66,7 +66,8 @@ public: virtual const char* GetFullDocumentation() { return - "ELSE(args), Note that the args for the ELSE clause must match those of the IF clause. See the IF command for more information."; + " ELSE(expression)\n" + "See IF command."; } cmTypeMacro(cmElseCommand, cmCommand); diff --git a/Source/cmEnableTestingCommand.h b/Source/cmEnableTestingCommand.h index 9d6b6950c6..fc37ee01e4 100644 --- a/Source/cmEnableTestingCommand.h +++ b/Source/cmEnableTestingCommand.h @@ -74,7 +74,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Enable testing for this directory and below."; + return "Enable testing for current directory and below."; } /** @@ -83,8 +83,11 @@ public: virtual const char* GetFullDocumentation() { return - "ENABLE_TESTING()\n" - "Enables testing for this directory and below. See also the ADD_TEST command. Note that Dart expects to find this file in the build directory root; therefore, this command should be in the source directory root too."; + " ENABLE_TESTING()\n" + "Enables testing for this directory and below. " + "See also the ADD_TEST command. Note that Dart expects to find " + "a test file in the build directory root. Therefore, this command " + "should be in the source directory root too."; } cmTypeMacro(cmEnableTestingCommand, cmCommand); diff --git a/Source/cmEndForEachCommand.h b/Source/cmEndForEachCommand.h index 06a40fce0c..51d05750fd 100644 --- a/Source/cmEndForEachCommand.h +++ b/Source/cmEndForEachCommand.h @@ -64,7 +64,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "ends a foreach block"; + return "Ends a list of commands in a FOREACH block."; } /** @@ -72,7 +72,9 @@ public: */ virtual const char* GetFullDocumentation() { - return "ENDFOREACH(define)"; + return + " ENDFOREACH(expression)\n" + "See FOREACH command."; } cmTypeMacro(cmEndForEachCommand, cmCommand); diff --git a/Source/cmEndIfCommand.h b/Source/cmEndIfCommand.h index 864297f7bc..1e47217149 100644 --- a/Source/cmEndIfCommand.h +++ b/Source/cmEndIfCommand.h @@ -57,7 +57,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "ends an if block"; + return "Ends a list of commands in an IF block."; } /** @@ -66,7 +66,8 @@ public: virtual const char* GetFullDocumentation() { return - "ENDIF(define)"; + " ENDIF(expression)\n" + "See IF command."; } cmTypeMacro(cmEndIfCommand, cmCommand); diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h index 560568c8ed..7379000ceb 100644 --- a/Source/cmExecProgramCommand.h +++ b/Source/cmExecProgramCommand.h @@ -64,12 +64,16 @@ public: virtual const char* GetFullDocumentation() { return - "EXEC_PROGRAM(Executable [Directory to run in] [ARGS arguments to executable] [OUTPUT_VARIABLE var] [RETURN_VALUE var])" - "The executable is run in the optionally specified Directory. The executable " - "can include arguments if it is double quoted, but it is better to use the " - "optional ARGS argument to specify arguments to the program. This is because " - "cmake will then be able to escape spaces in the Executable path. An optiona " - "argument OUTPUT_VARIABLE specifies a variable to which the output will be set. " + " EXEC_PROGRAM(Executable [directory in which to run]\n" + " [ARGS <arguments to executable>]\n" + " [OUTPUT_VARIABLE <var>]\n" + " [RETURN_VALUE <var>])\n" + "The executable is run in the optionally specified Directory. The " + "executable can include arguments if it is double quoted, but it is " + "better to use the optional ARGS argument to specify arguments to the " + "program. This is because cmake will then be able to escape spaces " + "in the Executable path. An optional argument OUTPUT_VARIABLE " + "specifies a variable in which to store the output. " "To capture the return value of the execution, use RETURN_VALUE variable. " "If OUTPUT_VARIABLE is specified, then no output will go to the stdout/stderr " "of the console running cmake."; diff --git a/Source/cmExportLibraryDependencies.h b/Source/cmExportLibraryDependencies.h index 67f8e985e2..2541d0abb0 100644 --- a/Source/cmExportLibraryDependencies.h +++ b/Source/cmExportLibraryDependencies.h @@ -67,12 +67,14 @@ public: virtual const char* GetFullDocumentation() { return - "EXPORT_LIBRARY_DEPENDENCIES(FILE [APPEND])\n" - "Create a file that can be included into a cmakelist file with the " - "INCLUDE command. The file will contain a number of SET commands " + " EXPORT_LIBRARY_DEPENDENCIES(FILE [APPEND])\n" + "Create a file that can be included into a CMake listfile with the " + "INCLUDE command. The file will contain a number of SET commands " "that will set all the variables needed for library dependency " "information. This should be the last command in the top level " - "CMakeLists.txt file of the project."; + "CMakeLists.txt file of the project. If the APPEND option is " + "specified, the SET commands will be appended to the given file " + "instead of replacing it."; } cmTypeMacro(cmExportLibraryDependenciesCommand, cmCommand); diff --git a/Source/cmFLTKWrapUICommand.h b/Source/cmFLTKWrapUICommand.h index 0c34cd377d..1c738ee9f3 100644 --- a/Source/cmFLTKWrapUICommand.h +++ b/Source/cmFLTKWrapUICommand.h @@ -69,12 +69,11 @@ public: virtual const char* GetFullDocumentation() { return - "FLTK_WRAP_UI(resultingLibraryName source1 source2 ... sourceN )\n" - "Produce .h and .cxx files for all the .fl and .fld file listed.\n" - "The .h files will be added to the library using the base name in\n" - "source list.\n" - "The .cxx files will be added to the library using the base name in \n" - "source list."; + " FLTK_WRAP_UI(resultingLibraryName source1\n" + " source2 ... sourceN )\n" + "Produce .h and .cxx files for all the .fl and .fld files listed. " + "The resulting .h and .cxx files will be added to the specified " + "library."; } private: diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h index ebf7144436..78e8666e09 100644 --- a/Source/cmFindFileCommand.h +++ b/Source/cmFindFileCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Find a file."; + return "Find the full path to a file."; } /** @@ -70,16 +70,15 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_FILE(NAME file extrapath extrapath ... [DOC docstring])" - "Find a file in the system PATH or in any extra paths specified in the command." - "A cache entry called NAME is created to store the result. " - " NAME-NOTFOUND is the value used if the file was not found. " - "As long as NOTFOUND is the value each time cmake will continue to " - "try and find the file each time it is run. " - " If DOC is specified the next argument is the " - "documentation string for the cache entry NAME. Since Executables, " - "can have different extensions on different platforms, FIND_PROGRAM," - " should be used instead of FIND_FILE when looking for and executable."; + " FIND_FILE(VAR fileName path1 path2 ... [DOC docstring])\n" + "If the file is found, then VAR is set to the path where it was found. " + "A cache entry named by VAR is created to " + "store the result. VAR-NOTFOUND is the value used if the file was " + "not found. CMake will continue to look as long as the value " + "is not found. If DOC is specified the next argument is the " + "documentation string for the cache entry VAR. Since Executables " + "can have different extensions on different platforms, FIND_PROGRAM " + "should be used instead of FIND_FILE when looking for and executable."; } cmTypeMacro(cmFindFileCommand, cmCommand); diff --git a/Source/cmFindLibraryCommand.h b/Source/cmFindLibraryCommand.h index 200979d8ef..b146984f8c 100644 --- a/Source/cmFindLibraryCommand.h +++ b/Source/cmFindLibraryCommand.h @@ -70,10 +70,16 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_LIBRARY(DEFINE_PATH libraryName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [DOC docstring] )\n" - "If the library is found, then DEFINE_PATH is set to the full path where it was found. " - "If DOC is specified the next argument is the " - "documentation string for the cache entry NAME."; + " FIND_LIBRARY(VAR libraryName\n" + " [NAMES name1 name2 ...]\n" + " [PATHS path1 path2 ...]\n" + " [DOC helpstring])\n" + "Find the library by looking in paths specified in the command. " + "A cache entry named by VAR is created to " + "store the result. VAR-NOTFOUND is the value used if the library was " + "not found. CMake will continue to look as long as the value " + "is not found. If DOC is specified the next argument is the " + "documentation string for the cache entry VAR."; } cmTypeMacro(cmFindLibraryCommand, cmCommand); diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h index 93f054a661..3dc659e461 100644 --- a/Source/cmFindPackageCommand.h +++ b/Source/cmFindPackageCommand.h @@ -61,10 +61,19 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_PACKAGE(<name> [major.minor])\n" - "Finds and loads settings from an external project. <name>_FOUND will\n" - "be set to indicate whether the package was found. Settings that\n" - "can be used when <name>_FOUND is true are package-specific."; + " FIND_PACKAGE(<name> [major.minor])\n" + "Finds and loads settings from an external project. <name>_FOUND will " + "be set to indicate whether the package was found. Settings that " + "can be used when <name>_FOUND is true are package-specific. The " + "package is found through several steps. " + "Directories listed in CMAKE_MODULE_PATH are searched for files called " + "\"Find<name>.cmake\". If such a file is found, it is read and " + "processed by CMake, and is responsible for finding the package. " + "If no such file is found, it is expected that the package is another " + "project built by CMake that has a \"<name>Config.cmake\" file. " + "A cache entry called <name>_DIR is created and is expected to be set " + "to the directory containing this file. If the file is found, it is " + "read and processed by CMake to load the settings of the package."; } cmTypeMacro(cmFindPackageCommand, cmCommand); diff --git a/Source/cmFindPathCommand.h b/Source/cmFindPathCommand.h index d64e02264e..c32ccf12d3 100644 --- a/Source/cmFindPathCommand.h +++ b/Source/cmFindPathCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Find a path for a file."; + return "Find the directory containing a file."; } /** @@ -70,10 +70,13 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_PATH(PATH_DEFINE fileName path1 path2 path3...)\n" - "If the file is found, then PATH_DEFINE is set to the path where it was found." - "If DOC is specified the next argument is the " - "documentation string for the cache entry NAME."; + " FIND_PATH(VAR fileName path1 path2 ... [DOC docstring])\n" + "If the file is found, then VAR is set to the path where it was found. " + "A cache entry named by VAR is created to " + "store the result. VAR-NOTFOUND is the value used if the file was " + "not found. CMake will continue to look as long as the value " + "is not found. If DOC is specified the next argument is the " + "documentation string for the cache entry VAR."; } cmTypeMacro(cmFindPathCommand, cmCommand); diff --git a/Source/cmFindProgramCommand.h b/Source/cmFindProgramCommand.h index 3c39cb8c13..99eb49c84b 100644 --- a/Source/cmFindProgramCommand.h +++ b/Source/cmFindProgramCommand.h @@ -70,13 +70,19 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_PROGRAM(DEFINE_NAME executableName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [NO_SYSTEM_PATH] [DOC helpstring]) " - "Find the executable in the system PATH or in any extra paths specified in the command." - "A cache entry called DEFILE_NAME is created to store the result. DEFILE_NAME-NOTFOUND is the value" - " used if the program was not found. CMake will continue to look as long as the value " - "is NOTFOUND If DOC is specified the next argument is the " - "documentation string for the cache entry NAME." - "If NO_SYSTEM_PATH is specified the contents of system PATH is not used"; + " FIND_PROGRAM(VAR executableName\n" + " [NAMES name1 name2 ...]\n" + " [PATHS path1 path2 ...]\n" + " [NO_SYSTEM_PATH]\n" + " [DOC helpstring])\n" + "Find the executable in the system PATH or in any extra paths " + "specified in the command. A cache entry named by VAR is created to " + "store the result. VAR-NOTFOUND is the value used if the program was " + "not found. CMake will continue to look as long as the value " + "is not found. If DOC is specified the next argument is the " + "documentation string for the cache entry VAR. " + "If NO_SYSTEM_PATH is specified the contents of system PATH are not " + "used."; } cmTypeMacro(cmFindProgramCommand, cmCommand); diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h index 95911e6ce9..f79075653a 100644 --- a/Source/cmForEachCommand.h +++ b/Source/cmForEachCommand.h @@ -80,7 +80,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "start a foreach loop"; + return "Evaluate a group of commands for each value in a list."; } /** @@ -89,7 +89,17 @@ public: virtual const char* GetFullDocumentation() { return - "FOREACH (define arg1 arg2 arg2) Starts a foreach block."; + " FOREACH(loop_var arg1 arg2 ...)\n" + " COMMAND1(ARGS ...)\n" + " COMMAND2(ARGS ...)\n" + " ...\n" + " ENDFOREACH(loop_var)\n" + "All commands between FOREACH and the matching ENDFOREACH are recorded " + "without being invoked. Once the ENDFOREACH is evaluated, the " + "recorded list of commands is invoked once for each argument listed " + "in the original FOREACH command. Each recorded command is modified " + "before invocation to replace any occurrence of \"${loop_var}\" with " + "the current value in the list."; } cmTypeMacro(cmForEachCommand, cmCommand); diff --git a/Source/cmGetFilenameComponentCommand.h b/Source/cmGetFilenameComponentCommand.h index 73a5a9cfcd..78616060cc 100644 --- a/Source/cmGetFilenameComponentCommand.h +++ b/Source/cmGetFilenameComponentCommand.h @@ -67,19 +67,24 @@ public: virtual const char* GetFullDocumentation() { return - "GET_FILENAME_COMPONENT(VarName FileName PATH|ABSOLUTE|NAME|EXT|NAME_WE|PROGRAM [PROGRAM_ARGS ArgVarName] [CACHE])\n" + " GET_FILENAME_COMPONENT(VarName FileName\n" + " PATH|ABSOLUTE|NAME|EXT|NAME_WE\n" + " [CACHE])\n" "Set VarName to be the path (PATH), file name (NAME), file " "extension (EXT), file name without extension (NAME_WE) of FileName, " "or the full absolute (ABSOLUTE) file name without symlinks. " "Note that the path is converted to Unix slashes format and has no " - "trailing slashes. The longest file extension is always considered.\n" - "Warning: as a utility command, the resulting value is not put in the " - "cache but in the definition list, unless you add the optional CACHE " - "parameter." - "For PROGRAM, the program in FileName will be found in the path or if it is " - "a full path. If PROGRAM_ARGS is present with PROGRAM, then the arguments " - "are split from the program. This is used to separate a program from its " - "arguments."; + "trailing slashes. The longest file extension is always considered. If " + "the optional CACHE argument is specified, the result variable is " + "added to the cache.\n" + " GET_FILENAME_COMPONENT(VarName FileName\n" + " PROGRAM [PROGRAM_ARGS ArgVar]\n" + " [CACHE])\n" + "The program in FileName will be found in the system search path or " + "left as a full path. If PROGRAM_ARGS is present with PROGRAM, then " + "any command-line arguments present in the FileName string are split " + "from the program name and stored in ArgVar. This is used to separate " + "a program name from its arguments in a command line string."; } cmTypeMacro(cmGetFilenameComponentCommand, cmCommand); diff --git a/Source/cmGetSourceFilePropertyCommand.h b/Source/cmGetSourceFilePropertyCommand.h index 0fd158ccba..b16bc60278 100644 --- a/Source/cmGetSourceFilePropertyCommand.h +++ b/Source/cmGetSourceFilePropertyCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Get a property for a file"; + return "Get a property for a source file."; } /** @@ -53,10 +53,12 @@ public: virtual const char* GetFullDocumentation() { return - "GET_SOURCE_FILE_PROPERTY(VAR file property) " - "Get a property from a source file. The value of the property is " - " stored in the variable VAR. If the property is not found, var " - "will be set to NOT_FOUND"; + " GET_SOURCE_FILE_PROPERTY(VAR file property)\n" + "Get a property from a source file. The value of the property is " + "stored in the variable VAR. If the property is not found, var " + "will be set to NOT_FOUND. Use SET_SOURCE_FILES_PROPERTIES to set " + "property values. Source file properties usually control how the " + "file is built."; } cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand); diff --git a/Source/cmGetTargetPropertyCommand.h b/Source/cmGetTargetPropertyCommand.h index 52075aabf0..4c819ef1e1 100644 --- a/Source/cmGetTargetPropertyCommand.h +++ b/Source/cmGetTargetPropertyCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Get a property for a file"; + return "Get a property from a target."; } /** @@ -53,10 +53,12 @@ public: virtual const char* GetFullDocumentation() { return - "GET_TARGET_PROPERTY(VAR target property) " - "Get a property from a source file. The value of the property is " - " stored in the variable VAR. If the property is not found, var " - "will be set to NOT_FOUND"; + " GET_TARGET_PROPERTY(VAR target property)\n" + "Get a property from a target. The value of the property is " + "stored in the variable VAR. If the property is not found, var " + "will be set to NOT_FOUND. Use SET_TARGET_PROPERTIES to set " + "property values. Properties are usually used to control how " + "a target is built."; } cmTypeMacro(cmGetTargetPropertyCommand, cmCommand); diff --git a/Source/cmITKWrapTclCommand.h b/Source/cmITKWrapTclCommand.h index c294acd53d..51ad4ccfb9 100644 --- a/Source/cmITKWrapTclCommand.h +++ b/Source/cmITKWrapTclCommand.h @@ -52,9 +52,11 @@ public: virtual const char* GetFullDocumentation() { return - "ITK_WRAP_TCL(target-name config-file1 [config-file2 ...])\n" - "Run CABLE on all the configuration files to generate Tcl wrappers.\n" - "The generated sources are added to a target of the given name."; + " ITK_WRAP_TCL(target-name config-file1 [config-file2 ...])\n" + "Run CABLE on all the configuration files to generate Tcl wrappers. " + "The generated sources are added to a target of the given name. This " + "command is provided for use by the Insight Toolkit (ITK) because it " + "was originally written before loaded commands were supported."; } cmTypeMacro(cmITKWrapTclCommand, cmCommand); diff --git a/Source/cmIfCommand.h b/Source/cmIfCommand.h index 27492a712b..49c54cacf5 100644 --- a/Source/cmIfCommand.h +++ b/Source/cmIfCommand.h @@ -79,7 +79,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "start an if block"; + return "Conditionally execute a group of commands."; } /** @@ -94,14 +94,53 @@ public: virtual const char* GetFullDocumentation() { return - "IF (define) Starts an if block. Optionally it can be invoked " - "using (NOT define) (def AND def2) (def OR def2) (def MATCHES def2) " - "(COMMAND cmd) (EXISTS file) MATCHES checks if def matches the " - "regular expression def2. COMMAND checks if the cmake command cmd " - "is in this cmake executable. EXISTS file checks if file exists." - "Additionally you can do comparisons using LESS GREATER STRLESS " - "and STRGREATER. LESS and GREATER do numeric comparison while " - "STRLESS and STRGREATER do string comparisons."; + " IF(expression)\n" + " # THEN section.\n" + " COMMAND1(ARGS ...)\n" + " COMMAND2(ARGS ...)\n" + " ...\n" + " ELSE(expression)\n" + " # ELSE section.\n" + " COMMAND1(ARGS ...)\n" + " COMMAND2(ARGS ...)\n" + " ...\n" + " ENDIF(expression)\n" + "Evaluates the given expression. If the result is true, the commands " + "in the THEN section are invoked. Otherwise, the commands in the " + "ELSE section are invoked. The ELSE section is optional. Note that " + "the same expression must be given to IF, ELSE, and ENDIF. Possible " + "expressions are:\n" + " IF(variable)\n" + "True if the variable's value is not empty, 0, FALSE, OFF, or NOTFOUND.\n" + " IF(NOT variable)\n" + "True if the variable's value is empty, 0, FALSE, OFF, or NOTFOUND.\n" + " IF(variable1 AND variable2)\n" + "True if both variables would be considered true individually. Only " + "one AND is allowed to keep expressions short.\n" + " IF(variable1 OR variable2)\n" + "True if either variable would be considered true individually. Only " + "one OR is allowed to keep expressions short.\n" + " IF(COMMAND command-name)\n" + "True if the given name is a command that can be invoked.\n" + " IF(EXISTS file-name)\n" + " IF(EXISTS directory-name)\n" + "True if the named file or directory exists.\n" + " IF(variable MATCHES regex)\n" + " IF(string MATCHES regex)\n" + "True if the given string or variable's value matches the given " + "regular expression.\n" + " IF(variable LESS number)\n" + " IF(string LESS number)\n" + " IF(variable GREATER number)\n" + " IF(string GREATER number)\n" + "True if the given string or variable's value is a valid number and " + "the inequality is true.\n" + " IF(variable STRLESS string)\n" + " IF(string STRLESS string)\n" + " IF(variable STRGREATER string)\n" + " IF(string STRGREATER string)\n" + "True if the given string or variable's value is lexicographically " + "less (or greater) than the string on the right."; } // this is a shared function for both If and Else to determine if diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h index b1159dfb81..7950e807a4 100644 --- a/Source/cmIncludeCommand.h +++ b/Source/cmIncludeCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Basically identical to a C #include \"something\" command."; + return "Read CMake listfile code from the given file."; } /** @@ -70,8 +70,11 @@ public: virtual const char* GetFullDocumentation() { return - "INCLUDE(file1 [OPTIONAL])\nIf OPTIONAL is present, then do not complain " - "if the file does not exist."; + " INCLUDE(file1 [OPTIONAL])\n" + "Reads CMake listfile code from the given file. Commands in the file " + "are processed immediately as if they were written in place of the " + "INCLUDE command. If OPTIONAL is present, then no error " + "is raised if the file does not exist."; } cmTypeMacro(cmIncludeCommand, cmCommand); diff --git a/Source/cmIncludeDirectoryCommand.h b/Source/cmIncludeDirectoryCommand.h index 95befcf616..a52a112545 100644 --- a/Source/cmIncludeDirectoryCommand.h +++ b/Source/cmIncludeDirectoryCommand.h @@ -68,7 +68,10 @@ public: virtual const char* GetFullDocumentation() { return - "INCLUDE_DIRECTORIES([BEFORE] dir1 dir2 ...)"; + " INCLUDE_DIRECTORIES([BEFORE] dir1 dir2 ...)\n" + "Add the given directories to those searched by the compiler for " + "include files. If BEFORE is specified, the directories are prepended " + "onto the current list of directories instead of appended."; } cmTypeMacro(cmIncludeDirectoryCommand, cmCommand); diff --git a/Source/cmIncludeExternalMSProjectCommand.h b/Source/cmIncludeExternalMSProjectCommand.h index d053e2d741..ee780b399b 100644 --- a/Source/cmIncludeExternalMSProjectCommand.h +++ b/Source/cmIncludeExternalMSProjectCommand.h @@ -63,7 +63,10 @@ public: virtual const char* GetFullDocumentation() { return - "INCLUDE_EXTERNAL_MSPROJECT(projectname location dep1 dep2 ...) Includes an external Microsoft project in the workspace file. Does nothing on UNIX currently\n"; + " INCLUDE_EXTERNAL_MSPROJECT(projectname location\n" + " dep1 dep2 ...)\n" + "Includes an external Microsoft project in the generated workspace " + "file. Currently does nothing on UNIX."; } cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand); diff --git a/Source/cmIncludeRegularExpressionCommand.h b/Source/cmIncludeRegularExpressionCommand.h index f09fc11abf..d419293835 100644 --- a/Source/cmIncludeRegularExpressionCommand.h +++ b/Source/cmIncludeRegularExpressionCommand.h @@ -72,13 +72,13 @@ public: virtual const char* GetFullDocumentation() { return - "INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain])\n" - "Set the regular expressions used in dependency checking. Only files\n" - "matching regex_match will be traced as dependencies. Only files\n" - "matching regex_complain will generate warnings if they cannot be found\n" + " INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain])\n" + "Set the regular expressions used in dependency checking. Only files " + "matching regex_match will be traced as dependencies. Only files " + "matching regex_complain will generate warnings if they cannot be found " "(standard header paths are not searched). The defaults are:\n" - " regex_match = \"^.*$\" (match everything)\n" - " regex_complain = \"^$\" (match empty string only)\n"; + " regex_match = \"^.*$\" (match everything)\n" + " regex_complain = \"^$\" (match empty string only)"; } cmTypeMacro(cmIncludeRegularExpressionCommand, cmCommand); diff --git a/Source/cmInstallFilesCommand.h b/Source/cmInstallFilesCommand.h index 892eb7ee34..8245881807 100644 --- a/Source/cmInstallFilesCommand.h +++ b/Source/cmInstallFilesCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create install rules for files"; + return "Create UNIX install rules for files."; } /** @@ -70,20 +70,24 @@ public: virtual const char* GetFullDocumentation() { return - "INSTALL_FILES(path extension file file ...)\n" - "INSTALL_FILES(path regexp)\n" - "INSTALL_FILES(path FILES file file ...)\n" - "Create rules to install the listed files into the path. Path is\n" - "relative to the variable CMAKE_INSTALL_PREFIX. There are three forms for\n" - "this command. In the first the files can be specified explicitly. If a\n" - "file specified already has an extension, that extension will be\n" - "removed first. This is useful for providing lists of source files such\n" - "as foo.cxx when you want the corresponding foo.h to be installed. A\n" - "typical extension is .h etc... In the second form any files in the\n" - "current directory that match the regular expression will be installed.\n" - "In the third form, any files listed after the FILES keyword will be\n" - "installed explicitly from the names given. Full paths are allowed in\n" - "this form."; + " INSTALL_FILES(<dir> extension file file ...)\n" + "Create rules to install the listed files with the given extension " + "into the given directory. " + "Only files existing in the current source tree or its corresponding " + "location in the binary tree may be listed. " + "If a file specified already has an extension, that extension will be " + "removed first. This is useful for providing lists of source files such " + "as foo.cxx when you want the corresponding foo.h to be installed. A" + "typical extension is '.h'.\n" + " INSTALL_FILES(<dir> regexp)\n" + "Any files in the current source directory that match the regular " + "expression will be installed.\n" + " INSTALL_FILES(<dir> FILES file file ...)\n" + "Any files listed after the FILES keyword will be " + "installed explicitly from the names given. Full paths are allowed in " + "this form.\n\n" + "The directory <dir> is relative to the installation prefix, which " + "is stored in the variable CMAKE_INSTALL_PREFIX."; } cmTypeMacro(cmInstallFilesCommand, cmCommand); diff --git a/Source/cmInstallProgramsCommand.h b/Source/cmInstallProgramsCommand.h index 41782960bd..e90f723e43 100644 --- a/Source/cmInstallProgramsCommand.h +++ b/Source/cmInstallProgramsCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create install rules for programs"; + return "Create UNIX install rules for programs."; } /** @@ -70,9 +70,16 @@ public: virtual const char* GetFullDocumentation() { return - "INSTALL_PROGRAMS(path file file ...)\n" - "INSTALL_PROGRAMS(path regexp)\n" - "Create rules to install the listed programs into the path. Path is relative to the variable CMAKE_INSTALL_PREFIX. There are two forms for this command. In the first the programs can be specified explicitly. In the second form any program in the current directory that match the regular expression will be installed."; + " INSTALL_PROGRAMS(<dir> file file ...)\n" + "Create rules to install the listed programs into the given directory.\n" + " INSTALL_PROGRAMS(<dir> regexp)\n" + "In the second form any program in the current source directory that " + "matches the regular expression will be installed.\n\n" + "This command is intended to install programs that are not built " + "by cmake, such as shell scripts. See INSTALL_TARGETS to " + "create installation rules for targets built by cmake.\n\n" + "The directory <dir> is relative to the installation prefix, which " + "is stored in the variable CMAKE_INSTALL_PREFIX."; } cmTypeMacro(cmInstallProgramsCommand, cmCommand); diff --git a/Source/cmInstallTargetsCommand.h b/Source/cmInstallTargetsCommand.h index 339888ddcc..b245447740 100644 --- a/Source/cmInstallTargetsCommand.h +++ b/Source/cmInstallTargetsCommand.h @@ -54,7 +54,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create install rules for targets"; + return "Create UNIX install rules for targets."; } /** @@ -63,8 +63,10 @@ public: virtual const char* GetFullDocumentation() { return - "INSTALL_TARGETS(path target target)\n" - "Create rules to install the listed targets into the path. Path is relative to the variable PREFIX"; + " INSTALL_TARGETS(<dir> target target)\n" + "Create rules to install the listed targets into the given directory. " + "The directory <dir> is relative to the installation prefix, which " + "is stored in the variable CMAKE_INSTALL_PREFIX."; } cmTypeMacro(cmInstallTargetsCommand, cmCommand); diff --git a/Source/cmLinkDirectoriesCommand.h b/Source/cmLinkDirectoriesCommand.h index ebbf6c66c2..6860dc8a53 100644 --- a/Source/cmLinkDirectoriesCommand.h +++ b/Source/cmLinkDirectoriesCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Specify link directories."; + return "Specify directories in which to search for libraries."; } /** @@ -70,10 +70,8 @@ public: virtual const char* GetFullDocumentation() { return - "LINK_DIRECTORIES(directory1 directory2 ...)\n" - "Specify the paths to the libraries that will be linked in.\n" - "The directories can use built in definitions like \n" - "CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR."; + " LINK_DIRECTORIES(directory1 directory2 ...)\n" + "Specify the paths in which the linker should search for libraries."; } cmTypeMacro(cmLinkDirectoriesCommand, cmCommand); diff --git a/Source/cmLinkLibrariesCommand.h b/Source/cmLinkLibrariesCommand.h index 729851b700..7404d56d03 100644 --- a/Source/cmLinkLibrariesCommand.h +++ b/Source/cmLinkLibrariesCommand.h @@ -60,9 +60,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return - "Specify a list of libraries to be linked into\n" - "executables or shared objects."; + return "Link libraries to all targets added later."; } /** @@ -71,14 +69,15 @@ public: virtual const char* GetFullDocumentation() { return - "LINK_LIBRARIES(library1 <debug | optimized> library2 ...)\n" + " LINK_LIBRARIES(library1 <debug | optimized> library2 ...)\n" "Specify a list of libraries to be linked into " "any following targets (typically added with the ADD_EXECUTABLE " "or ADD_LIBRARY calls). This command is passed " - "down to all other commands. " + "down to all subdirectories. " "The debug and optimized strings may be used to indicate that " "the next library listed is to be used only for that specific " - "type of build"; + "type of build. Considure using TARGET_LINK_LIBRARIES for more " + "specific linking control."; } cmTypeMacro(cmLinkLibrariesCommand, cmCommand); diff --git a/Source/cmLoadCacheCommand.h b/Source/cmLoadCacheCommand.h index 925cd3b896..1eef5b8f23 100644 --- a/Source/cmLoadCacheCommand.h +++ b/Source/cmLoadCacheCommand.h @@ -55,7 +55,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "load in the values from another cache."; + return "Load in the values from another project's CMake cache."; } /** @@ -64,16 +64,23 @@ public: virtual const char* GetFullDocumentation() { return - "LOAD_CACHE(pathToCacheFile [EXCLUDE entry1...] [INCLUDE_INTERNALS entry1...])\n" - "LOAD_CACHE(pathToCacheFile READ_WITH_PREFIX prefix entry1...)\n" - "Load in the values from another cache. This is useful for a project " - "that depends on another project built in a different tree." - "EXCLUDE option can be used to provide a list of entries to be excluded." + " LOAD_CACHE(pathToCacheFile READ_WITH_PREFIX\n" + " prefix entry1...)\n" + "Read the cache and store the requested entries in variables with " + "their name prefixed with the given prefix. " + "This only reads the values, and does not create entries in the local " + "project's cache.\n" + " LOAD_CACHE(pathToCacheFile [EXCLUDE entry1...]\n" + " [INCLUDE_INTERNALS entry1...])\n" + "Load in the values from another cache and store them in the local " + "project's cache as internal entries. This is useful for a project " + "that depends on another project built in a different tree. " + "EXCLUDE option can be used to provide a list of entries to be " + "excluded. " "INCLUDE_INTERNALS can be used to provide a list of internal entries" - "to be included. Normally, no internal entries are brougt in.\n" - "The READ_WITH_PREFIX form will read the cache and store the requested " - "entries in variables with their name prefixed with the given prefix. " - "This form only reads the values, and does not create local cache entries."; + "to be included. Normally, no internal entries are brougt in. Use " + "of this form of the command is strongly discouraged, but it is " + "provided for backward compatability."; } cmTypeMacro(cmLoadCacheCommand, cmCommand); diff --git a/Source/cmLoadCommandCommand.h b/Source/cmLoadCommandCommand.h index 4a60e32088..17de45a0ae 100644 --- a/Source/cmLoadCommandCommand.h +++ b/Source/cmLoadCommandCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Load a command into a running CMake"; + return "Load a command into a running CMake."; } /** @@ -67,7 +67,11 @@ public: virtual const char* GetFullDocumentation() { return - "LOAD_COMMAND(command)\n"; + " LOAD_COMMAND(COMMAND_NAME <loc1> [loc2 ...])\n" + "The given locations are searched for a library whose name is " + "cmCOMMAND_NAME. If found, it is loaded as a module and the command " + "is added to the set of available CMake commands. Usually, TRY_COMPILE " + "is used before this command to compile the module."; } cmTypeMacro(cmLoadCommandCommand, cmCommand); diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h index e090ec723d..4a0c95b676 100644 --- a/Source/cmMacroCommand.h +++ b/Source/cmMacroCommand.h @@ -78,7 +78,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "start defining a Macro."; + return "Start recording a macro for later invocation as a command."; } /** @@ -87,7 +87,17 @@ public: virtual const char* GetFullDocumentation() { return - "MACRO(name arg1 arg2 arg3 ...) Starts to define a macro named name that takes arguments named arg1 arg2 arg3... When the macro is invoked the actual arguments passed replace the formal arguments. "; + " MACRO(<name> [arg1 [arg2 [arg3 ...]]])\n" + " COMMAND1(ARGS ...)\n" + " COMMAND2(ARGS ...)\n" + " ...\n" + " ENDMACRO(<name>)\n" + "Define a macro named <name> that takes arguments named " + "arg1 arg2 arg3 (...). Commands listed after MACRO, " + "but before the matching ENDMACRO, are not invoked until the macro " + "is invoked. When it is invoked, the commands recorded in the " + "macro are first modified by replacing formal parameters (${arg1}) with " + "the arguments passed, and then invoked as normal commands."; } cmTypeMacro(cmMacroCommand, cmCommand); diff --git a/Source/cmMakeDirectoryCommand.h b/Source/cmMakeDirectoryCommand.h index 4cdda4d94e..9f0709c018 100644 --- a/Source/cmMakeDirectoryCommand.h +++ b/Source/cmMakeDirectoryCommand.h @@ -56,8 +56,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create a directory in the build tree if it does not exist.\n" - "Parent directories will be created if the do not exist.."; + return "Create a directory on the file system."; } /** @@ -66,7 +65,10 @@ public: virtual const char* GetFullDocumentation() { return - "MAKE_DIRECTORY(directory)"; + " MAKE_DIRECTORY(directory)\n" + "Creates the specified directory. Full paths should be given. Any " + "parent directories that do not exist will also be created. Use with " + "care."; } cmTypeMacro(cmMakeDirectoryCommand, cmCommand); diff --git a/Source/cmMarkAsAdvancedCommand.h b/Source/cmMarkAsAdvancedCommand.h index defaf61bbe..c78de7b9c7 100644 --- a/Source/cmMarkAsAdvancedCommand.h +++ b/Source/cmMarkAsAdvancedCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Mark a cmake variable as advanced."; + return "Mark cmake cached variables as advanced."; } /** @@ -67,12 +67,16 @@ public: virtual const char* GetFullDocumentation() { return - "MARK_AS_ADVANCED([CLEAR|FORCE]VAR VAR2 VAR... )\n" - "Mark the named variables as advanced. An advanced variable will not be displayed in" - " any of the cmake GUIs, unless the show advanced option is on. " - "If CLEAR is the first argument advanced variables are changed back to unadvanced." - "If FORCE is the first arguement, then the variable is made advanced." - "If neither FORCE or CLEAR is specified, new values will be marked as advanced, but if the variable already has an advanced state, it will not be changed."; + " MARK_AS_ADVANCED([CLEAR|FORCE] VAR VAR2 VAR...)\n" + "Mark the named cached variables as advanced. An advanced variable " + "will not be displayed in any of the cmake GUIs unless the show " + "advanced option is on. " + "If CLEAR is the first argument advanced variables are changed back " + "to unadvanced. " + "If FORCE is the first arguement, then the variable is made advanced. " + "If neither FORCE or CLEAR is specified, new values will be marked as " + "advanced, but if the variable already has an advanced/non-advanced " + "state, it will not be changed."; } cmTypeMacro(cmMarkAsAdvancedCommand, cmCommand); diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h index 6ff5512047..ba60de4eb6 100644 --- a/Source/cmMessageCommand.h +++ b/Source/cmMessageCommand.h @@ -60,8 +60,11 @@ public: virtual const char* GetFullDocumentation() { return - "MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] \"message to display\"...)\n" - "The arguments are messages to display. If the first argument is SEND_ERROR then an error is raised. If the first argument is STATUS then the message is diaplyed in the progress line for the GUI"; + " MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR]\n" + " \"message to display\" ...)\n" + "The arguments are messages to display. If the first argument is " + "SEND_ERROR then an error is raised. If the first argument is " + "STATUS then the message is diaplyed in the progress line for the GUI."; } cmTypeMacro(cmMessageCommand, cmCommand); diff --git a/Source/cmOptionCommand.h b/Source/cmOptionCommand.h index 8cad383633..da8dd69ecc 100644 --- a/Source/cmOptionCommand.h +++ b/Source/cmOptionCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Provides an option that the user can optionally select"; + return "Provides an option that the user can optionally select."; } /** @@ -67,8 +67,10 @@ public: virtual const char* GetFullDocumentation() { return - "OPTION(USE_MPI \"help string decribing the option\" [initial value])\n" - "Provide an option for the user to select"; + " OPTION(OPTION_VAR \"help string decribing option\"\n" + " [initial value])\n" + "Provide an option for the user to select as ON or OFF. If no " + "initial value is provided, OFF is used."; } cmTypeMacro(cmOptionCommand, cmCommand); diff --git a/Source/cmOutputRequiredFilesCommand.h b/Source/cmOutputRequiredFilesCommand.h index 4bf0a94488..36bf6764a8 100644 --- a/Source/cmOutputRequiredFilesCommand.h +++ b/Source/cmOutputRequiredFilesCommand.h @@ -63,7 +63,7 @@ public: virtual const char* GetFullDocumentation() { return - "OUTPUT_REQUIRED_FILES(srcfile outputfile)\n" + " OUTPUT_REQUIRED_FILES(srcfile outputfile)\n" "Outputs a list of all the source files that are required by the specified srcfile. This list is written into outputfile. This is similar to writing out the dependencies for srcfile except that it jumps from .h files into .cxx, .c and .cpp files if possible."; } diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h index 8c57e06cbb..5b1b55b317 100644 --- a/Source/cmProjectCommand.h +++ b/Source/cmProjectCommand.h @@ -64,7 +64,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Set a name for the entire project. One argument."; + return "Set a name for the entire project."; } /** @@ -73,7 +73,7 @@ public: virtual const char* GetFullDocumentation() { return - "PROJECT(projectname [C++ C Java])\n" + " PROJECT(projectname [C++] [C] [Java])\n" "Sets the name of the project. " "This creates the variables projectname_BINARY_DIR and projectname_SOURCE_DIR. " "Optionally you can specify which languages your project supports. " diff --git a/Source/cmQTWrapCPPCommand.h b/Source/cmQTWrapCPPCommand.h index 6b4255a8df..705b90b153 100644 --- a/Source/cmQTWrapCPPCommand.h +++ b/Source/cmQTWrapCPPCommand.h @@ -69,9 +69,10 @@ public: virtual const char* GetFullDocumentation() { return - "QT_WRAP_CPP(resultingLibraryName DestName SourceLists ...)\n" - "Produce moc files for all the .h file listed in the SourceLists.\n" - "The moc files will be added to the library using the DestName\n" + " QT_WRAP_CPP(resultingLibraryName DestName\n" + " SourceLists ...)\n" + "Produce moc files for all the .h file listed in the SourceLists. " + "The moc files will be added to the library using the DestName " "source list."; } diff --git a/Source/cmQTWrapUICommand.h b/Source/cmQTWrapUICommand.h index 28560dffcd..908f2fb1c5 100644 --- a/Source/cmQTWrapUICommand.h +++ b/Source/cmQTWrapUICommand.h @@ -69,13 +69,13 @@ public: virtual const char* GetFullDocumentation() { return - "QT_WRAP_UI(resultingLibraryName HeadersDestName SourcesDestName " - "SourceLists ...)\n" + " QT_WRAP_UI(resultingLibraryName HeadersDestName\n" + " SourcesDestName SourceLists ...)\n" "Produce .h and .cxx files for all the .ui file listed " - "in the SourceLists.\n" - "The .h files will be added to the library using the HeadersDestName\n" - "source list.\n" - "The .cxx files will be added to the library using the SourcesDestName\n" + "in the SourceLists. " + "The .h files will be added to the library using the HeadersDestName" + "source list. " + "The .cxx files will be added to the library using the SourcesDestName" "source list."; } diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h index e8cba844d1..197e443ef6 100644 --- a/Source/cmRemoveCommand.h +++ b/Source/cmRemoveCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Remove a value from a CMAKE variable"; + return "Remove a value from a list in a variable."; } /** @@ -67,10 +67,10 @@ public: virtual const char* GetFullDocumentation() { return - "REMOVE(VAR VALUE VALUE ...)\n" - "Removes VALUE from the CMAke variable VAR. " + " REMOVE(VAR VALUE VALUE ...)\n" + "Removes VALUE from the variable VAR. " "This is typically used to remove entries from a vector " - "(e.g. semicolon separated list). VALUE is expanded. "; + "(e.g. semicolon separated list). VALUE is expanded."; } cmTypeMacro(cmRemoveCommand, cmCommand); diff --git a/Source/cmSeparateArgumentsCommand.h b/Source/cmSeparateArgumentsCommand.h index a63f59e0db..5984170883 100644 --- a/Source/cmSeparateArgumentsCommand.h +++ b/Source/cmSeparateArgumentsCommand.h @@ -67,8 +67,10 @@ public: virtual const char* GetFullDocumentation() { return - "SEPARATE_ARGUMENTS(VARIABLE)\n" - "Convert the value of VARIABLE to a semi-colon separated list. All spaces are replaced with ;"; + " SEPARATE_ARGUMENTS(VARIABLE)\n" + "Convert the value of VARIABLE to a semi-colon separated list. " + "All spaces are replaced with ';'. This helps with generating " + "command lines."; } cmTypeMacro(cmSeparateArgumentsCommand, cmCommand); diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index b3b39a8b70..f93f4ddf9d 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Set a CMAKE variable to a value"; + return "Set a CMAKE variable to a given value."; } /** @@ -67,16 +67,16 @@ public: virtual const char* GetFullDocumentation() { return - "SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n" - "Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR " - "is set to it. If CACHE is present, then the VAR is put in the cache." - " TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, STRING, INTERNAL, " - "or STATIC. If TYPE is INTERNAL, then the " - " VALUE is Always written into the cache, replacing any values " + " SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n" + "Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR " + "is set to it. If CACHE is present, then the VAR is put in the cache. " + "TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, " + "STRING, INTERNAL, or STATIC. If TYPE is INTERNAL, then the " + "VALUE is Always written into the cache, replacing any values " "existing in the cache. If it is not a CACHE VAR, then this always " "writes into the current makefile. The FORCE option will overwrite" "the CACHE value removing any changes from the USER.\n" - "An optional syntax is SET(VAR VALUE1 ... VALUEN).\n" + " SET(VAR VALUE1 ... VALUEN).\n" "In this case VAR is set to a ; separated list of values."; } diff --git a/Source/cmSetSourceFilesPropertiesCommand.h b/Source/cmSetSourceFilesPropertiesCommand.h index 1acbc64ff4..6c10d68437 100644 --- a/Source/cmSetSourceFilesPropertiesCommand.h +++ b/Source/cmSetSourceFilesPropertiesCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Set attributes for a specific list of files."; + return "Source files can have properties that affect how they are built."; } /** @@ -53,16 +53,30 @@ public: virtual const char* GetFullDocumentation() { return - "SET_SOURCE_FILES_PROPERTIES(file1 file2 .. filen PROPERTIES prop1 value1 prop2 value2 ... prop2 valuen)" - "Set properties on a file. The syntax for the command is to list all the files you want " - "to change, and then provide the values you want to set next. You can make up your own properties as well. " + " SET_SOURCE_FILES_PROPERTIES(file1 file2 ...\n" + " PROPERTIES prop1 value1\n" + " prop2 value2 ...)\n" + "Set properties on a file. The syntax for the command is to list all " + "the files you want " + "to change, and then provide the values you want to set next. You " + "can make up your own properties as well. " "The following are used by CMake. " - "The ABSTRACT flag (boolean) appears to have some effect on the VTK wrapper commands. " - "If WRAP_EXCLUDE (boolean) is true then the wrapping commands (FLTKWrapUI, QTWrapCC, QTWrapUI, VTKMakeInstantiator, VTKWrapJava, VTKWrapPython, and VTKWrapTcl) will ignore this file. " - "If GENERATED (boolean) is true then it is not an error if this source file does not exist when it is added to a target. Obviously, it must be created (presumably by a custom command) before the target is built. " - "If the HEADER_FILE_ONLY (boolean) property is true then dependency information is not created for that file (this is set automatically, based on the file's name's extension and is probably only used by Makefiles). " + "The ABSTRACT flag (boolean) appears to have some effect on the VTK " + "wrapper commands. " + "If WRAP_EXCLUDE (boolean) is true then the wrapping commands " + "(FLTKWrapUI, QTWrapCC, QTWrapUI, VTKMakeInstantiator, VTKWrapJava, " + "VTKWrapPython, and VTKWrapTcl) will ignore this file. " + "If GENERATED (boolean) is true then it is not an error if this " + "source file does not exist when it is added to a target. Obviously, " + "it must be created (presumably by a custom command) before the " + "target is built. " + "If the HEADER_FILE_ONLY (boolean) property is true then dependency " + "information is not created for that file (this is set " + "automatically, based on the file's name's extension and is probably " + "only used by Makefiles). " "OBJECT_DEPENDS (string) adds dependencies to the object file. " - "COMPILE_FLAGS (string) is passed to the compiler as additional command line arguments when the source file is compiled. "; + "COMPILE_FLAGS (string) is passed to the compiler as additional " + "command line arguments when the source file is compiled. "; } diff --git a/Source/cmSetTargetPropertiesCommand.h b/Source/cmSetTargetPropertiesCommand.h index 37a1bfc223..28c96777d4 100644 --- a/Source/cmSetTargetPropertiesCommand.h +++ b/Source/cmSetTargetPropertiesCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Set attributes for a specific list of files."; + return "Targets can have properties that affect how they are built."; } /** @@ -53,13 +53,21 @@ public: virtual const char* GetFullDocumentation() { return - "SET_TARGET_PROPERTIES(target1 target2 .. filen PROPERTIES prop1 value1 prop2 value2 ... prop2 valuen)" - "Set properties on a target. The syntax for the command is to list all the files you want " - "to change, and then provide the values you want to set next. Properties that cmake knows about are PREFIX and SUFFIX for Unix systems and libraries. CMake also knows about LINK_FLAGS, which can be used to add extra flags to the link step of a target." - "DEFINE_SYMBOL is a symbol that is defined when compiling C or C++ sources. " + " SET_TARGET_PROPERTIES(target1 target2 ...\n" + " PROPERTIES prop1 value1\n" + " prop2 value2 ...)\n" + "Set properties on a target. The syntax for the command is to " + "list all the files you want " + "to change, and then provide the values you want to set next. " + "Properties that cmake knows about are PREFIX and SUFFIX for Unix " + "systems and libraries. CMake also knows about LINK_FLAGS, which " + "can be used to add extra flags to the link step of a target." + "DEFINE_SYMBOL is a symbol that is defined when compiling C or C++ " + "sources. " "If not set here then it is set to target_EXPORTS by default " "(with some substitutions if target is not a valid C identifier). " - "You can use and prop value pair you want and extract it later with the GET_TARGET_PROPERTY command."; + "You can use and prop value pair you want and extract it later with " + "the GET_TARGET_PROPERTY command."; } cmTypeMacro(cmSetTargetPropertiesCommand, cmCommand); diff --git a/Source/cmSiteNameCommand.h b/Source/cmSiteNameCommand.h index 9345ee2ae9..45500c06e6 100644 --- a/Source/cmSiteNameCommand.h +++ b/Source/cmSiteNameCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Set a CMAKE variable to the name of this computer."; + return "Set the given variable to the name of the computer."; } /** @@ -67,8 +67,7 @@ public: virtual const char* GetFullDocumentation() { return - "SITE_NAME(NAME)\n" - "Within CMAKE sets NAME to the host name of the computer."; + " SITE_NAME(variable)\n"; } cmTypeMacro(cmSiteNameCommand, cmCommand); diff --git a/Source/cmSourceFilesCommand.h b/Source/cmSourceFilesCommand.h index 4ccc2c3d18..6d5c3fd7a9 100644 --- a/Source/cmSourceFilesCommand.h +++ b/Source/cmSourceFilesCommand.h @@ -67,7 +67,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Add a list of source files, associate them with a NAME."; + return "Deprecated. Use SET to list sources in a variable."; } /** @@ -76,7 +76,12 @@ public: virtual const char* GetFullDocumentation() { return - "SOURCE_FILES(NAME file1 file2 ... [ GENERATED generated_file1 ... ])"; + " SOURCE_FILES(variable file1 file2 ...\n" + " [ GENERATED generated_file1 ... ])\n" + "Adds the given sources to the list in the given variable. Sources " + "listed after GENERATED will be given the GENERATED property. See " + "SET_SOURCE_FILES_PROPERTIES to add the GENERATED property to any " + "source."; } cmTypeMacro(cmSourceFilesCommand, cmCommand); diff --git a/Source/cmSourceFilesRemoveCommand.h b/Source/cmSourceFilesRemoveCommand.h index ad8ad69510..e209e3c506 100644 --- a/Source/cmSourceFilesRemoveCommand.h +++ b/Source/cmSourceFilesRemoveCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Remove a list of source files - associated with NAME."; + return "Remove sources from those listed in the given variable."; } /** @@ -69,7 +69,9 @@ public: virtual const char* GetFullDocumentation() { return - "SOURCE_FILES_REMOVE(NAME file1 file2 ...)"; + " SOURCE_FILES_REMOVE(variable file1 file2 ...)\n" + "Removes the sources specified from the sources listed in the given " + "variable."; } cmTypeMacro(cmSourceFilesRemoveCommand, cmCommand); diff --git a/Source/cmSourceGroupCommand.h b/Source/cmSourceGroupCommand.h index 3367809368..dea98508c2 100644 --- a/Source/cmSourceGroupCommand.h +++ b/Source/cmSourceGroupCommand.h @@ -71,9 +71,9 @@ public: virtual const char* GetFullDocumentation() { return - "SOURCE_GROUP(name regex)\n" - "Defines a new source group. Any file whose name matches the regular\n" - "expression will be placed in this group. The LAST regular expression\n" + " SOURCE_GROUP(name regex)\n" + "Defines a new source group. Any file whose name matches the regular " + "expression will be placed in this group. The LAST regular expression " "of all defined SOURCE_GROUPs that matches the file will be selected."; } diff --git a/Source/cmStringCommand.h b/Source/cmStringCommand.h index 298d730b3c..8123b678b3 100644 --- a/Source/cmStringCommand.h +++ b/Source/cmStringCommand.h @@ -60,21 +60,28 @@ public: virtual const char* GetFullDocumentation() { return - "STRING(REGEX MATCH <regular_expression> <output variable> <input> [<input>...])\n" - "STRING(REGEX MATCHALL <regular_expression> <output variable> <input> [<input>...])\n" - "STRING(REGEX REPLACE <regular_expression> <replace_expression> <output variable> <input> [<input>...])\n" - "STRING(COMPARE EQUAL <string1> <string2> <output variable>)\n" - "STRING(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n" - "STRING(COMPARE LESS <string1> <string2> <output variable>)\n" - "STRING(COMPARE GREATER <string1> <string2> <output variable>)\n" - "STRING(ASCII <number> [<number> ...] <output variable>)\n" - "REGEX MATCH will match the regular expression once and store the match in the output variable.\n" - "REGEX MATCHALL will match the regular expression as many times as possible and store the matches\n" - " in the output variable as a list.\n" - "REGEX REPLACE will match the regular expression as many times as possible and substitute the\n" - " replacement expression for the match in the output.\n" - "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store true or false in the output variable.\n" - "ASCII will convert all numbers into corresponding ASCII characters.\n"; + " STRING(REGEX MATCH <regular_expression>\n" + " <output variable> <input> [<input>...])\n" + " STRING(REGEX MATCHALL <regular_expression>\n" + " <output variable> <input> [<input>...])\n" + " STRING(REGEX REPLACE <regular_expression>\n" + " <replace_expression> <output variable>\n" + " <input> [<input>...])\n" + " STRING(COMPARE EQUAL <string1> <string2> <output variable>)\n" + " STRING(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n" + " STRING(COMPARE LESS <string1> <string2> <output variable>)\n" + " STRING(COMPARE GREATER <string1> <string2> <output variable>)\n" + " STRING(ASCII <number> [<number> ...] <output variable>)\n" + "REGEX MATCH will match the regular expression once and store the " + "match in the output variable.\n\n" + "REGEX MATCHALL will match the regular expression as many times as " + "possible and store the matches in the output variable as a list.\n\n" + "REGEX REPLACE will match the regular expression as many times as " + "possible and substitute the replacement expression for the match " + "in the output.\n\n" + "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and " + "store true or false in the output variable.\n\n" + "ASCII will convert all numbers into corresponding ASCII characters."; } cmTypeMacro(cmStringCommand, cmCommand); diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h index acdcd367e1..7c111283cd 100644 --- a/Source/cmSubdirCommand.h +++ b/Source/cmSubdirCommand.h @@ -63,7 +63,7 @@ public: virtual const char* GetFullDocumentation() { return - "SUBDIRS(dir1 dir2 ...)\n" + " SUBDIRS(dir1 dir2 ...)\n" "Add a list of subdirectories to the build. " "This will cause any CMakeLists.txt files in the sub directories " "to be processed by CMake."; diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h index d84542e19c..06cc1dde9c 100644 --- a/Source/cmSubdirDependsCommand.h +++ b/Source/cmSubdirDependsCommand.h @@ -63,8 +63,8 @@ public: virtual const char* GetFullDocumentation() { return - "SUBDIR_DEPENDS(subdir dep1 dep2 ...)\n" - "Does not do anything. This command used to help projects order\n" + " SUBDIR_DEPENDS(subdir dep1 dep2 ...)\n" + "Does not do anything. This command used to help projects order " "parallel builds correctly. This functionality is now automatic."; } diff --git a/Source/cmTargetLinkLibrariesCommand.h b/Source/cmTargetLinkLibrariesCommand.h index 744f6d45e9..696fd1aa25 100644 --- a/Source/cmTargetLinkLibrariesCommand.h +++ b/Source/cmTargetLinkLibrariesCommand.h @@ -55,8 +55,7 @@ public: virtual const char* GetTerseDocumentation() { return - "Specify a list of libraries to be linked into\n" - "executables or shared objects."; + "Link a target to given libraries."; } /** @@ -65,10 +64,12 @@ public: virtual const char* GetFullDocumentation() { return - "TARGET_LINK_LIBRARIES(target library1 <debug | optimized> library2 ...)\n" - "Specify a list of libraries to be linked into the specified target\n" - "The debug and optimized strings may be used to indicate that\n" - "the next library listed is to be used only for that specific\n" + " TARGET_LINK_LIBRARIES(target library1\n" + " <debug | optimized> library2\n" + " ...)\n" + "Specify a list of libraries to be linked into the specified target " + "The debug and optimized strings may be used to indicate that " + "the next library listed is to be used only for that specific " "type of build"; } diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h index dd1a71a3b2..ca99b7ea37 100644 --- a/Source/cmTryCompileCommand.h +++ b/Source/cmTryCompileCommand.h @@ -52,7 +52,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Try compiling some code"; + return "Try compiling some code."; } /** @@ -75,14 +75,16 @@ public: virtual const char* GetFullDocumentation() { return - "TRY_COMPILE(RESULT_VAR bindir srcdir projectName <CMAKE_FLAGS <Flags>>)\n" - "Try compiling a program. Return the success or failure in RESULT_VAR " + " TRY_COMPILE(RESULT_VAR bindir srcdir\n" + " projectName <CMAKE_FLAGS <Flags>>)\n" + "Try compiling a program. Return the success or failure in RESULT_VAR. " "If <target name> is specified then build just that target " "otherwise the all or ALL_BUILD target is built.\n" - "TRY_COMPILE(RESULT_VAR bindir srcfile\n" - " <CMAKE_FLAGS <Flags>> <COMPILE_DEFINITIONS <flags> ...>)\n" - "Try compiling a srcfile. Return the success or failure in RESULT_VAR. " - "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. The " + " TRY_COMPILE(RESULT_VAR bindir srcfile\n" + " <CMAKE_FLAGS <Flags>>\n" + " <COMPILE_DEFINITIONS <flags> ...>)\n" + "Try compiling a srcfile. Return the success or failure in RESULT_VAR. " + "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. The " "COMPILE_DEFINITIONS are -Ddefinition that will be passed to the " "compile line. If srcfile is specified the files in bindir/CMakeTmp " "are cleaned."; diff --git a/Source/cmTryRunCommand.h b/Source/cmTryRunCommand.h index ddd2212283..e8d20c551e 100644 --- a/Source/cmTryRunCommand.h +++ b/Source/cmTryRunCommand.h @@ -55,17 +55,19 @@ public: return "Try compiling and then running some code."; } - /** * More documentation. */ virtual const char* GetFullDocumentation() { return - "TRY_RUN(RUN_RESULT_VAR COMPILE_RESULT_VAR bindir srcfile <CMAKE_FLAGS <Flags>> <COMPILE_DEFINITIONS <flags>> <ARGUMENTS <arg1> <arg2>...>)\n" - "Try compiling a srcfile. Return the success or failure in " - "COMPILE_RESULT_VAR. Then if the compile succeeded, run the " - "executable and return the result in RUN_RESULT_VAR. "; + " TRY_RUN(RUN_RESULT_VAR COMPILE_RESULT_VAR\n" + " bindir srcfile <CMAKE_FLAGS <Flags>>\n" + " <COMPILE_DEFINITIONS <flags>>\n" + " <ARGUMENTS <arg1> <arg2>...>)\n" + "Try compiling a srcfile. Return the success or failure in " + "COMPILE_RESULT_VAR. Then if the compile succeeded, run the " + "executable and return the result in RUN_RESULT_VAR."; } cmTypeMacro(cmTryRunCommand, cmCommand); diff --git a/Source/cmUseMangledMesaCommand.h b/Source/cmUseMangledMesaCommand.h index d3a0eff541..ca994af061 100644 --- a/Source/cmUseMangledMesaCommand.h +++ b/Source/cmUseMangledMesaCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create copies of mesa headers for use in combination with system gl."; + return "Copy mesa headers for use in combination with system GL."; } /** @@ -62,8 +62,11 @@ public: virtual const char* GetFullDocumentation() { return - "USE_MANGLED_MESA(PATH_TO_MESA OUTPUT_DIRECTORY)\n" - "The path to mesa includes, should contain gl_mangle.h. "; + " USE_MANGLED_MESA(PATH_TO_MESA OUTPUT_DIRECTORY)\n" + "The path to mesa includes, should contain gl_mangle.h. " + "The mesa headers are copied to the specified output directory. " + "This allows mangled mesa headers to override other GL headers by " + "being added to the include directory path earlier."; } protected: diff --git a/Source/cmUtilitySourceCommand.h b/Source/cmUtilitySourceCommand.h index 0e71c48b24..ba7012a530 100644 --- a/Source/cmUtilitySourceCommand.h +++ b/Source/cmUtilitySourceCommand.h @@ -71,11 +71,12 @@ public: virtual const char* GetFullDocumentation() { return - "UTILITY_SOURCE(cache_entry executable_name path_to_source [file1 file2 ...])\n" - "When a third-party utility's source is included in the distribution,\n" - "this command specifies its location and name. The cache entry will\n" - "not be set unless the path_to_source and all listed files exist. It\n" - "is assumed that the source tree of the utility will have been built\n" + " UTILITY_SOURCE(cache_entry executable_name\n" + " path_to_source [file1 file2 ...])\n" + "When a third-party utility's source is included in the distribution, " + "this command specifies its location and name. The cache entry will " + "not be set unless the path_to_source and all listed files exist. It " + "is assumed that the source tree of the utility will have been built " "before it is needed."; } diff --git a/Source/cmVTKMakeInstantiatorCommand.h b/Source/cmVTKMakeInstantiatorCommand.h index f1cbb2f3d5..658cea74ce 100644 --- a/Source/cmVTKMakeInstantiatorCommand.h +++ b/Source/cmVTKMakeInstantiatorCommand.h @@ -45,34 +45,35 @@ public: /** Succinct documentation. */ virtual const char* GetTerseDocumentation() { - return "Register classes for creation by vtkInstantiator"; + return "Deprecated. For use only in VTK 4.0."; } /** More documentation. */ virtual const char* GetFullDocumentation() { return - "VTK_MAKE_INSTANTIATOR(className outSourceList\n" - " src-list1 [src-list2 ..]\n" - " EXPORT_MACRO exportMacro\n" - " [HEADER_LOCATION dir] [GROUP_SIZE groupSize]\n" - " [INCLUDES [file1 file2 ..]])\n" - "Generates a new class with the given name and adds its files to the\n" - "given outSourceList. It registers the classes from the other given\n" - "source lists with vtkInstantiator when it is loaded. The output\n" - "source list should be added to the library with the classes it\n" - "registers.\n" - "The EXPORT_MACRO argument must be given and followed by the export\n" - "macro to use when generating the class (ex. VTK_COMMON_EXPORT).\n" - "The HEADER_LOCATION option must be followed by a path. It specifies\n" - "the directory in which to place the generated class's header file.\n" - "The generated class implementation files always go in the build\n" - "directory corresponding to the CMakeLists.txt file containing\n" - "the command. This is the default location for the header.\n" - "The INCLUDES option can be followed by a list of zero or more files.\n" - "These files will be #included by the generated instantiator header,\n" - "and can be used to gain access to the specified exportMacro in the\n" - " C++ code."; + " VTK_MAKE_INSTANTIATOR(className outSourceList\n" + " src-list1 [src-list2 ..]\n" + " EXPORT_MACRO exportMacro\n" + " [HEADER_LOCATION dir]\n" + " [GROUP_SIZE groupSize]\n" + " [INCLUDES [file1 file2 ..]])\n" + "Generates a new class with the given name and adds its files to the " + "given outSourceList. It registers the classes from the other given " + "source lists with vtkInstantiator when it is loaded. The output " + "source list should be added to the library with the classes it " + "registers. " + "The EXPORT_MACRO argument must be given and followed by the export " + "macro to use when generating the class (ex. VTK_COMMON_EXPORT). " + "The HEADER_LOCATION option must be followed by a path. It specifies " + "the directory in which to place the generated class's header file. " + "The generated class implementation files always go in the build " + "directory corresponding to the CMakeLists.txt file containing " + "the command. This is the default location for the header. " + "The INCLUDES option can be followed by a list of zero or more files. " + "These files will be #included by the generated instantiator header, " + "and can be used to gain access to the specified exportMacro in the " + "C++ code."; } cmTypeMacro(cmVTKMakeInstantiatorCommand, cmCommand); diff --git a/Source/cmVTKWrapJavaCommand.h b/Source/cmVTKWrapJavaCommand.h index 92139b7ec1..13e2156036 100644 --- a/Source/cmVTKWrapJavaCommand.h +++ b/Source/cmVTKWrapJavaCommand.h @@ -60,7 +60,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create Java Wrappers."; + return "Deprecated. For use only in VTK 4.0."; } /** @@ -69,7 +69,9 @@ public: virtual const char* GetFullDocumentation() { return - "VTK_WRAP_JAVA(resultingLibraryName SourceListName SourceLists ...)"; + " VTK_WRAP_JAVA(resultingLibraryName SourceListName\n" + " class1 class2 ...)\n" + "Create Java wrappers for VTK classes."; } private: diff --git a/Source/cmVTKWrapPythonCommand.h b/Source/cmVTKWrapPythonCommand.h index 7f66104b7b..4d6ef73ab9 100644 --- a/Source/cmVTKWrapPythonCommand.h +++ b/Source/cmVTKWrapPythonCommand.h @@ -60,7 +60,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create Python Wrappers."; + return "Deprecated. For use only in VTK 4.0."; } /** @@ -69,7 +69,9 @@ public: virtual const char* GetFullDocumentation() { return - "VTK_WRAP_PYTHON(resultingLibraryName SourceListName SourceLists ...)"; + " VTK_WRAP_PYTHON(resultingLibraryName SourceListName\n" + " class1 class2 ...)\n" + "Create Python wrappers for VTK classes."; } /** diff --git a/Source/cmVTKWrapTclCommand.h b/Source/cmVTKWrapTclCommand.h index c96f4a5530..4ae1ef232a 100644 --- a/Source/cmVTKWrapTclCommand.h +++ b/Source/cmVTKWrapTclCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Create Tcl Wrappers for VTK classes."; + return "Deprecated. For use only in VTK 4.0."; } /** @@ -70,7 +70,10 @@ public: virtual const char* GetFullDocumentation() { return - "VTK_WRAP_TCL(resultingLibraryName [SOURCES] SourceListName SourceLists ... [COMMANDS CommandName1 CommandName2 ...])"; + " VTK_WRAP_TCL(resultingLibraryName [SOURCES]\n" + " SourceListName class1 class2 ...\n" + " [COMMANDS CommandName1 CommandName2 ...])\n" + "Create Tcl wrappers for VTK classes."; } /** diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h index 896cfe2603..0e6f46c53a 100644 --- a/Source/cmVariableRequiresCommand.h +++ b/Source/cmVariableRequiresCommand.h @@ -53,7 +53,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Display an error message ."; + return "Assert satisfaction of an option's required variables."; } /** @@ -62,16 +62,17 @@ public: virtual const char* GetFullDocumentation() { return - "VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE " - "REQUIRED_VARIABLE1 REQUIRED_VARIABLE2 ...) " + " VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE\n" + " REQUIRED_VARIABLE1\n" + " REQUIRED_VARIABLE2 ...)\n" "The first argument (TEST_VARIABLE) is the name of the variable to be " "tested, if that variable is false nothing else is done. If " "TEST_VARIABLE is true, then " "the next arguemnt (RESULT_VARIABLE) is a vairable that is set to true " - "if all the " - "required variables are set." + "if all the required variables are set." "The rest of the arguments are variables that must be true or not " - "set to NOTFOUND to avoid an error. "; + "set to NOTFOUND to avoid an error. If any are not true, an error " + "is reported."; } cmTypeMacro(cmVariableRequiresCommand, cmCommand); diff --git a/Source/cmWrapExcludeFilesCommand.h b/Source/cmWrapExcludeFilesCommand.h index 9f4a61f7e5..5fda5fc2e3 100644 --- a/Source/cmWrapExcludeFilesCommand.h +++ b/Source/cmWrapExcludeFilesCommand.h @@ -44,7 +44,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "A list of classes, to exclude from wrapping."; + return "Deprecated. See SET_SOURCE_FILES_PROPERTIES."; } /** @@ -53,7 +53,8 @@ public: virtual const char* GetFullDocumentation() { return - "WRAP_EXCLUDE_FILES(file1 file2 ..)"; + " WRAP_EXCLUDE_FILES(file1 file2 ...)\n" + "Marks files with the WRAP_EXCLUDE property."; } cmTypeMacro(cmWrapExcludeFilesCommand, cmCommand); diff --git a/Source/cmWriteFileCommand.h b/Source/cmWriteFileCommand.h index 5a07e3d20c..914cc16e37 100644 --- a/Source/cmWriteFileCommand.h +++ b/Source/cmWriteFileCommand.h @@ -60,7 +60,7 @@ public: virtual const char* GetFullDocumentation() { return - "WRITE_FILE(filename \"message to write\"... [APPEND])\n" + " WRITE_FILE(filename \"message to write\"... [APPEND])\n" "The first argument is the file name, the rest of the arguments are " "messages to write. If the argument APPEND is specified, then " "the message will be appended."; |