summaryrefslogtreecommitdiffstats
path: root/Source/cmAddCustomCommandCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmAddCustomCommandCommand.h')
-rw-r--r--Source/cmAddCustomCommandCommand.h47
1 files changed, 30 insertions, 17 deletions
diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h
index b158ca3..a48bf15 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);