kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

STYLE: make formatting of help a bit more consistent 

Alex
This commit is contained in:
Alexander Neundorf 2007-12-20 17:49:38 -05:00
parent f69a6a7c8c
commit 355b1f23af
7 changed files with 26 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Source/cmAuxSourceDirectoryCommand.h
View File

@ -64,9 +64,9 @@ public:
virtual const char* GetFullDocumentation()
{
return
" aux_source_directory(dir VARIABLE)\n"
" aux_source_directory(<dir> <variable>)\n"
"Collects the names of all the source files in the specified "
"directory and stores the list in the variable provided. This "
"directory and stores the list in the <variable> provided. This "
"command is intended to be used by projects that use explicit "
"template instantiation. Template instantiation files can be "
"stored in a \"Templates\" subdirectory and collected automatically "

6
Source/cmBuildCommand.h
View File

@ -60,10 +60,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
" build_command(variable MAKECOMMAND)\n"
"Sets the given variable to a string containing the command that "
" 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, "
"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.";
}

4
Source/cmCreateTestSourceList.h
View File

@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" create_test_sourcelist(SourceListName DriverName\n"
" create_test_sourcelist(sourceListName driverName\n"
" test1 test2 test3\n"
" EXTRA_INCLUDE include.h\n"
" FUNCTION function)\n"
@ -68,7 +68,7 @@ public:
"a single executable. This is useful when building static executables "
"with large libraries to shrink the total required size. "
"The list of source files "
"needed to build the test driver will be in SourceListName. "
"needed to build the test driver will be in sourceListName. "
"DriverName is the name of the test driver program. The rest of "
"the arguments consist of a list of test source files, can be "
"semicolon separated. Each test source file should have a function in "

2
Source/cmExportCommand.h
View File

@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" export(TARGETS tgt1 tgt2 ... [PREFIX <prefix>] FILE <filename> "
" export(TARGETS tgt1 ... tgtN [PREFIX <prefix>] FILE <filename> "
"[APPEND])\n"
"Create a file that can be included into a CMake listfile with the "
"INCLUDE command. The file will contain a number of SET commands "

8
Source/cmExportLibraryDependencies.h
View File

@ -68,10 +68,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
" export_library_dependencies(FILE [APPEND])\n"
"Create a file that can be included into a CMake listfile with the "
"INCLUDE command. The file will contain a number of SET commands "
"that will set all the variables needed for library dependency "
" export_library_dependencies(<file> [APPEND])\n"
"Create a file named <file> that can be included into a CMake listfile "
"with the INCLUDE command. The file will contain a number of SET "
"commands that will set all the variables needed for library dependency "
"information. This should be the last command in the top level "
"CMakeLists.txt file of the project. If the APPEND option is "
"specified, the SET commands will be appended to the given file "

2
Source/cmOptionCommand.h
View File

@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" option(OPTION_VAR \"help string describing option\"\n"
" option(<option_variable> \"help string describing 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.";

25
Source/cmSetCommand.h
View File

@ -65,25 +65,26 @@ public:
virtual const char* GetFullDocumentation()
{
return
" set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
"Within CMake sets VAR to the value VALUE. VALUE is expanded before "
"VAR is set to it. If CACHE is present, then the VAR is put in the "
"cache. TYPE and DOCSTRING are required. TYPE is used by the CMake GUI "
"to choose a widget with which the user sets a value. The value for "
"TYPE may be one of\n"
" set(<variable> <value> [CACHE <type> <docstring> [FORCE]])\n"
"Within CMake sets <variable> to the value <value>. <value> is expanded"
" before <variable> is set to it. If CACHE is present, then the "
"<variable> is put in the cache. <type> and <docstring> are then "
"required. <type> is used by the CMake GUI to choose a widget with "
"which the user sets a value. The value for <type> may be one of\n"
" FILEPATH = File chooser dialog.\n"
" PATH = Directory chooser dialog.\n"
" STRING = Arbitrary string.\n"
" BOOL = Boolean ON/OFF checkbox.\n"
" INTERNAL = No GUI entry (used for persistent variables).\n"
"If TYPE is INTERNAL, then the VALUE is always written into the cache, "
"replacing any values existing in the cache. If it is not a cache "
"variable, then this always writes into the current makefile. The "
"If <type> is INTERNAL, then the <value> is always written into the "
"cache, replacing any values existing in the cache. If it is not a "
"cache variable, then this always writes into the current makefile. The "
"FORCE option will overwrite the cache value removing any changes by "
"the user.\n"
" set(VAR VALUE1 ... VALUEN).\n"
"In this case VAR is set to a semicolon separated list of values.\n"
"VAR can be an environment variable such as:\n"
" set(<variable> <value1> ... <valueN>)\n"
"In this case <variable> is set to a semicolon separated list of "
"values.\n"
"<variable> can be an environment variable such as:\n"
" set( ENV{PATH} /home/martink )\n"
"in which case the environment variable will be set.";
}