summaryrefslogtreecommitdiffstats
path: root/Source/cmAddCustomTargetCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmAddCustomTargetCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmAddCustomTargetCommand.h')
-rw-r--r--Source/cmAddCustomTargetCommand.h15
1 files changed, 10 insertions, 5 deletions
diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h
index 988fce5..37f8537 100644
--- a/Source/cmAddCustomTargetCommand.h
+++ b/Source/cmAddCustomTargetCommand.h
@@ -55,9 +55,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Add an extra target to the build system that "
- "does not produce output, so it"
- " is run each time the target is built.";
+ return "Add a target with no output so it will always be built.";
}
/**
@@ -66,8 +64,15 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n"
- "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.";
+ " ADD_CUSTOM_TARGET(Name [ALL] [ command arg arg arg ... ])\n"
+ "Adds a target with the given name that executes the given command "
+ "every time the target is built. If the ALL option is specified "
+ "it indicates that this target should be added to the default build "
+ "target so that it will be run every time. "
+ "The command and arguments are optional. If not specified, "
+ "it will create an empty target. The ADD_DEPENDENCIES command can be "
+ "used in conjunction with this command to drive custom target "
+ "generation. The command cannot be called ALL.";
}
cmTypeMacro(cmAddCustomTargetCommand, cmCommand);