diff options
| author | Brad King <brad.king@kitware.com> | 2003-02-14 23:47:16 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2003-02-14 23:47:16 (GMT) |
| commit | a02574158d178615cf8fd642695e5099b6041049 (patch) | |
| tree | df9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmOptionCommand.h | |
| parent | dec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff) | |
| download | CMake-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/cmOptionCommand.h')
| -rw-r--r-- | Source/cmOptionCommand.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Source/cmOptionCommand.h b/Source/cmOptionCommand.h index 8cad383..da8dd69 100644 --- a/Source/cmOptionCommand.h +++ b/Source/cmOptionCommand.h @@ -58,7 +58,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Provides an option that the user can optionally select"; + return "Provides an option that the user can optionally select."; } /** @@ -67,8 +67,10 @@ public: virtual const char* GetFullDocumentation() { return - "OPTION(USE_MPI \"help string decribing the option\" [initial value])\n" - "Provide an option for the user to select"; + " OPTION(OPTION_VAR \"help string decribing option\"\n" + " [initial value])\n" + "Provide an option for the user to select as ON or OFF. If no " + "initial value is provided, OFF is used."; } cmTypeMacro(cmOptionCommand, cmCommand); |