summaryrefslogtreecommitdiff
path: root/Source/cmStringCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
committerBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmStringCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadcmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmStringCommand.h')
-rw-r--r--Source/cmStringCommand.h37
1 files changed, 22 insertions, 15 deletions
diff --git a/Source/cmStringCommand.h b/Source/cmStringCommand.h
index 298d730b3c..8123b678b3 100644
--- a/Source/cmStringCommand.h
+++ b/Source/cmStringCommand.h
@@ -60,21 +60,28 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "STRING(REGEX MATCH <regular_expression> <output variable> <input> [<input>...])\n"
- "STRING(REGEX MATCHALL <regular_expression> <output variable> <input> [<input>...])\n"
- "STRING(REGEX REPLACE <regular_expression> <replace_expression> <output variable> <input> [<input>...])\n"
- "STRING(COMPARE EQUAL <string1> <string2> <output variable>)\n"
- "STRING(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n"
- "STRING(COMPARE LESS <string1> <string2> <output variable>)\n"
- "STRING(COMPARE GREATER <string1> <string2> <output variable>)\n"
- "STRING(ASCII <number> [<number> ...] <output variable>)\n"
- "REGEX MATCH will match the regular expression once and store the match in the output variable.\n"
- "REGEX MATCHALL will match the regular expression as many times as possible and store the matches\n"
- " in the output variable as a list.\n"
- "REGEX REPLACE will match the regular expression as many times as possible and substitute the\n"
- " replacement expression for the match in the output.\n"
- "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store true or false in the output variable.\n"
- "ASCII will convert all numbers into corresponding ASCII characters.\n";
+ " STRING(REGEX MATCH <regular_expression>\n"
+ " <output variable> <input> [<input>...])\n"
+ " STRING(REGEX MATCHALL <regular_expression>\n"
+ " <output variable> <input> [<input>...])\n"
+ " STRING(REGEX REPLACE <regular_expression>\n"
+ " <replace_expression> <output variable>\n"
+ " <input> [<input>...])\n"
+ " STRING(COMPARE EQUAL <string1> <string2> <output variable>)\n"
+ " STRING(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n"
+ " STRING(COMPARE LESS <string1> <string2> <output variable>)\n"
+ " STRING(COMPARE GREATER <string1> <string2> <output variable>)\n"
+ " STRING(ASCII <number> [<number> ...] <output variable>)\n"
+ "REGEX MATCH will match the regular expression once and store the "
+ "match in the output variable.\n\n"
+ "REGEX MATCHALL will match the regular expression as many times as "
+ "possible and store the matches in the output variable as a list.\n\n"
+ "REGEX REPLACE will match the regular expression as many times as "
+ "possible and substitute the replacement expression for the match "
+ "in the output.\n\n"
+ "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and "
+ "store true or false in the output variable.\n\n"
+ "ASCII will convert all numbers into corresponding ASCII characters.";
}
cmTypeMacro(cmStringCommand, cmCommand);