summaryrefslogtreecommitdiffstats
path: root/Source/cmAddCustomCommandCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2003-06-03 14:47:31 (GMT)
committerKen Martin <ken.martin@kitware.com>2003-06-03 14:47:31 (GMT)
commit9c0aa78c0d562eb363d8579bb9ed5777d2eff00a (patch)
tree6c7c86bd659fce2e5f448283f27de5b146c26735 /Source/cmAddCustomCommandCommand.h
parent7b3f2d4420a0df7faf374b1b5c306df1d9d0e312 (diff)
downloadCMake-9c0aa78c0d562eb363d8579bb9ed5777d2eff00a.zip
CMake-9c0aa78c0d562eb363d8579bb9ed5777d2eff00a.tar.gz
CMake-9c0aa78c0d562eb363d8579bb9ed5777d2eff00a.tar.bz2
better docs
Diffstat (limited to 'Source/cmAddCustomCommandCommand.h')
-rw-r--r--Source/cmAddCustomCommandCommand.h26
1 files changed, 6 insertions, 20 deletions
diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h
index 218b676..114ac22 100644
--- a/Source/cmAddCustomCommandCommand.h
+++ b/Source/cmAddCustomCommandCommand.h
@@ -23,25 +23,9 @@
/** \class cmAddCustomCommandCommand
* \brief
*
- * cmAddCustomCommandCommand defines a new command that can
- * be executed within the CMake
+ * cmAddCustomCommandCommand defines a new command (rule) that can
+ * be executed within the build process
*
- * In makefile terms this creates new target in the following form:
- * OUTPUT1: SOURCE DEPENDS
- * COMMAND ARGS
- * OUTPUT2: SOURCE DEPENDS
- * COMMAND ARGS
- * ...
- * Example of usage:
- * ADD_CUSTOM_COMMAND(
- * SOURCE ${VTK_TIFF_FAX_EXE}
- * COMMAND ${VTK_TIFF_FAX_EXE}
- * ARGS -c const ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c
- * TARGET vtktiff
- * OUTPUTS ${VTK_BINARY_DIR}/Utilities/tiff/tif_fax3sm.c
- * )
- * This will create custom target which will generate file tif_fax3sm.c
- * using command ${VTK_TIFF_FAX_EXE}.
*/
class cmAddCustomCommandCommand : public cmCommand
@@ -88,7 +72,7 @@ public:
return
"There are two main signatures for ADD_CUSTOM_COMMAND "
"The first signature is for adding a custom command "
- "to a source file.\n"
+ "to produce an output.\n"
" ADD_CUSTOM_COMMAND(OUTPUT result\n"
" COMMAND command\n"
" [ARGS [args...]]\n"
@@ -96,7 +80,9 @@ public:
" [DEPENDS [depends...]]\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 "
+ "process. Note that MAIN_DEPENDENCY is completely optional and is "
+ "used as a suggestion to visual studio about where to hang the "
+ "custom command In makefile terms this creates a new target in the "
"following form:\n"
" OUTPUT: MAIN_DEPENDENCY DEPENDS\n"
" COMMAND ARGS\n"