summaryrefslogtreecommitdiffstats
path: root/Source/cmBuildCommand.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/cmBuildCommand.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/cmBuildCommand.h')
-rw-r--r--Source/cmBuildCommand.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/Source/cmBuildCommand.h b/Source/cmBuildCommand.h
index 9275604..56d5d32 100644
--- a/Source/cmBuildCommand.h
+++ b/Source/cmBuildCommand.h
@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Determine the command line that will build this project.";
+ return "Get the command line that will build this project.";
}
/**
@@ -67,8 +67,12 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "BUILD_COMMAND(NAME MAKECOMMAND)\n"
- "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.";
+ " BUILD_COMMAND(variable MAKECOMMAND)\n"
+ "Sets the given variable to a string containing the command that "
+ "will build this project from the root of the build tree using the "
+ "build tool given by MAKECOMMAND. MAKECOMMAND should be msdev, "
+ "nmake, make or one of the end user build tools. "
+ "This is useful for configuring testing systems.";
}
cmTypeMacro(cmBuildCommand, cmCommand);