kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ENH: clean up docs some

This commit is contained in:
Bill Hoffman 2002-12-30 07:47:03 -05:00
parent 1bf59ded66
commit 455b262cfe
10 changed files with 33 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Source/cmAbstractFilesCommand.h
View File

@ -44,7 +44,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "A list of abstract classes, useful for wrappers."; return "Depricated command, see SET_SOURCE_FILES_PROPERTIES.";
} }
/** /**
@ -53,7 +53,7 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"ABSTRACT_FILES(file1 file2 ..)"; "ABSTRACT_FILES(file1 file2 ..).";
} }
cmTypeMacro(cmAbstractFilesCommand, cmCommand); cmTypeMacro(cmAbstractFilesCommand, cmCommand);

17
Source/cmAddCustomCommandCommand.h
View File

@ -88,7 +88,22 @@ public:
return return
"ADD_CUSTOM_COMMAND([SOURCE source] [COMMAND command] TARGET target " "ADD_CUSTOM_COMMAND([SOURCE source] [COMMAND command] TARGET target "
"[ARGS [args...]] [DEPENDS [depends...]] [OUTPUTS [outputs...]] [COMMENT comment])\n" "[ARGS [args...]] [DEPENDS [depends...]] [OUTPUTS [outputs...]] [COMMENT comment])\n"
"Add a custom command."; "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"
" 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>";
} }
cmTypeMacro(cmAddCustomCommandCommand, cmCommand); cmTypeMacro(cmAddCustomCommandCommand, cmCommand);

2
Source/cmAddCustomTargetCommand.h
View File

@ -67,7 +67,7 @@ public:
{ {
return return
"ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n" "ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n"
"The ALL option is optional. If it is specified it indicates that this target should be added to the Build all target. The command and arguments are optional. If not specified, it will create an empy target. Command cannot be called ALL."; "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.";
} }
cmTypeMacro(cmAddCustomTargetCommand, cmCommand); cmTypeMacro(cmAddCustomTargetCommand, cmCommand);

2
Source/cmAddDefinitionsCommand.h
View File

@ -69,7 +69,7 @@ public:
{ {
return return
"ADD_DEFINITIONS(-DFOO -DBAR ...)\n" "ADD_DEFINITIONS(-DFOO -DBAR ...)\n"
"Add -D define flags to command line for environments."; "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.";
} }
cmTypeMacro(cmAddDefinitionsCommand, cmCommand); cmTypeMacro(cmAddDefinitionsCommand, cmCommand);

9
Source/cmAddExecutableCommand.h
View File

@ -53,7 +53,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Add an executable to the project that uses the specified srclists"; return "Add an executable to the project that uses the specified source files.";
} }
/** /**
@ -62,13 +62,12 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"ADD_EXECUTABLE(exename srclist srclist srclist ...)\n" "ADD_EXECUTABLE(exename [WIN32] source1 source2 ... sourceN)\n"
"ADD_EXECUTABLE(exename WIN32 srclist srclist srclist ...)"
"This command adds an executable target to the current directory. " "This command adds an executable target to the current directory. "
"The executable will be built from the source files / source lists " "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) " "which indicates that the executable (when compiled on windows) "
"is a windows app (using WinMain)not a console app (using main)."; "is a windows app (using WinMain) not a console app (using main).";
} }
cmTypeMacro(cmAddExecutableCommand, cmCommand); cmTypeMacro(cmAddExecutableCommand, cmCommand);

6
Source/cmAddTestCommand.h
View File

@ -67,12 +67,12 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"ADD_TEST(testname exename arg1 arg2 arg3 ...)\n" "ADD_TEST(testname Exename arg1 arg2 arg3 ...)\n"
"If the ENABLE_TESTING command has been run, this command adds a" "If the ENABLE_TESTING command has been run, this command adds a"
"test target to the current directory. If ENABLE_TESTING has not" "test target to the current directory. If ENABLE_TESTING has not"
"been run, this command does nothing.\n" "been run, this command does nothing.\n"
"The tests are run by the testing subsystem by executing exename " "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 " "built by built by this project or an arbitrary executable on the "
"system (like tclsh)."; "system (like tclsh).";
} }

4
Source/cmAuxSourceDirectoryCommand.h
View File

@ -57,7 +57,7 @@ public:
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Add all the source files found in the specified\n" return "Add all the source files found in the specified\n"
"directory to the build as source list NAME."; "directory to the variable name specified.";
} }
/** /**
@ -66,7 +66,7 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"AUX_SOURCE_DIRECTORY(dir srcListName)"; "AUX_SOURCE_DIRECTORY(dir VARIABLE)";
} }
cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand); cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand);

2
Source/cmBuildCommand.h
View File

@ -68,7 +68,7 @@ public:
{ {
return return
"BUILD_COMMAND(NAME MAKECOMMAND)\n" "BUILD_COMMAND(NAME MAKECOMMAND)\n"
"Within CMAKE set NAME to the command that will build this project from the command line using MAKECOMMAND."; "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.";
} }
cmTypeMacro(cmBuildCommand, cmCommand); cmTypeMacro(cmBuildCommand, cmCommand);

2
Source/cmBuildNameCommand.h
View File

@ -58,7 +58,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Set a CMAKE variable to the build type."; return "Depricated command. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead..";
} }
/** /**

5
Source/cmFLTKWrapUICommand.h
View File

@ -69,9 +69,8 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"FLTK_WRAP_UI(resultingLibraryName SourceList)\n" "FLTK_WRAP_UI(resultingLibraryName source1 source2 ... sourceN )\n"
"Produce .h and .cxx files for all the .fl and .fld file listed " "Produce .h and .cxx files for all the .fl and .fld file listed.\n"
"in the SourceList.\n"
"The .h files will be added to the library using the base name in\n" "The .h files will be added to the library using the base name in\n"
"source list.\n" "source list.\n"
"The .cxx files will be added to the library using the base name in \n" "The .cxx files will be added to the library using the base name in \n"