summaryrefslogtreecommitdiff
path: root/Source/cmAddCustomCommandCommand.h
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2002-12-30 07:47:03 -0500
committerBill Hoffman <bill.hoffman@kitware.com>2002-12-30 07:47:03 -0500
commit455b262cfeaedaa9f472e4f80160fd06d9331459 (patch)
treebfb329a39ac5fd2c51d7fdc896aab3704555ea0c /Source/cmAddCustomCommandCommand.h
parent1bf59ded665ebd20b2633a43abab4a89d34fff4f (diff)
downloadcmake-455b262cfeaedaa9f472e4f80160fd06d9331459.tar.gz
ENH: clean up docs some
Diffstat (limited to 'Source/cmAddCustomCommandCommand.h')
-rw-r--r--Source/cmAddCustomCommandCommand.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h
index e2afc239e4..b158ca31e0 100644
--- a/Source/cmAddCustomCommandCommand.h
+++ b/Source/cmAddCustomCommandCommand.h
@@ -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);