Commit 455b262c authored by Bill Hoffman's avatar Bill Hoffman
Browse files

ENH: clean up docs some

parent 1bf59ded
......@@ -44,7 +44,7 @@ public:
*/
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()
{
return
"ABSTRACT_FILES(file1 file2 ..)";
"ABSTRACT_FILES(file1 file2 ..).";
}
cmTypeMacro(cmAbstractFilesCommand, cmCommand);
......
......@@ -88,7 +88,22 @@ public:
return
"ADD_CUSTOM_COMMAND([SOURCE source] [COMMAND command] TARGET target "
"[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);
......
......@@ -67,7 +67,7 @@ public:
{
return
"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);
......
......@@ -69,7 +69,7 @@ public:
{
return
"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);
......
......@@ -53,7 +53,7 @@ public:
*/
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()
{
return
"ADD_EXECUTABLE(exename srclist srclist srclist ...)\n"
"ADD_EXECUTABLE(exename WIN32 srclist srclist srclist ...)"
"ADD_EXECUTABLE(exename [WIN32] source1 source2 ... sourceN)\n"
"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 "
"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);
......
......@@ -67,12 +67,12 @@ public:
virtual const char* GetFullDocumentation()
{
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"
"test target to the current directory. If ENABLE_TESTING has not"
"been run, this command does nothing.\n"
"The tests are run by the testing subsystem by executing exename "
"with the specified arguments. exename can be either an executable "
"The tests are run by the testing subsystem by executing Exename "
"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).";
}
......
......@@ -57,7 +57,7 @@ public:
virtual const char* GetTerseDocumentation()
{
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()
{
return
"AUX_SOURCE_DIRECTORY(dir srcListName)";
"AUX_SOURCE_DIRECTORY(dir VARIABLE)";
}
cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand);
......
......@@ -68,7 +68,7 @@ public:
{
return
"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);
......
......@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
return "Set a CMAKE variable to the build type.";
return "Depricated command. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead..";
}
/**
......
......@@ -69,9 +69,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
"FLTK_WRAP_UI(resultingLibraryName SourceList)\n"
"Produce .h and .cxx files for all the .fl and .fld file listed "
"in the SourceList.\n"
"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"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment