summaryrefslogtreecommitdiff
path: root/Source
diff options
context:
space:
mode:
Diffstat (limited to 'Source')
-rw-r--r--Source/cmAbstractFilesRule.h4
-rw-r--r--Source/cmAddTargetRule.h4
-rw-r--r--Source/cmAuxSourceDirectoryRule.h4
-rw-r--r--Source/cmExecutablesRule.h4
-rw-r--r--Source/cmFindIncludeRule.h4
-rw-r--r--Source/cmFindLibraryRule.h4
-rw-r--r--Source/cmFindProgramRule.h4
-rw-r--r--Source/cmIncludeDirectoryRule.h4
-rw-r--r--Source/cmLibraryRule.h4
-rw-r--r--Source/cmLinkDirectoriesRule.h6
-rw-r--r--Source/cmLinkLibrariesRule.h8
-rw-r--r--Source/cmMakefile.cxx4
-rw-r--r--Source/cmProjectRule.h7
-rw-r--r--Source/cmRuleMaker.h4
-rw-r--r--Source/cmSourceFilesRequireRule.h4
-rw-r--r--Source/cmSourceFilesRule.h4
-rw-r--r--Source/cmSubdirRule.h4
-rw-r--r--Source/cmTestsRule.h4
-rw-r--r--Source/cmUnixDefinesRule.h4
-rw-r--r--Source/cmUnixLibrariesRule.h4
-rw-r--r--Source/cmWin32DefinesRule.h4
-rw-r--r--Source/cmWin32LibrariesRule.h4
22 files changed, 48 insertions, 49 deletions
diff --git a/Source/cmAbstractFilesRule.h b/Source/cmAbstractFilesRule.h
index 717dd6ddf7..5eb51fca1a 100644
--- a/Source/cmAbstractFilesRule.h
+++ b/Source/cmAbstractFilesRule.h
@@ -47,7 +47,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "A list of abstract classes, useful for wrappers.";
}
@@ -55,7 +55,7 @@ public:
/**
* Longer documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"ABSTRACT_FILES(file1 file2 ..)";
diff --git a/Source/cmAddTargetRule.h b/Source/cmAddTargetRule.h
index 6272c3278f..65d57e8c98 100644
--- a/Source/cmAddTargetRule.h
+++ b/Source/cmAddTargetRule.h
@@ -58,7 +58,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add an extra target to the build system.";
}
@@ -66,7 +66,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"ADD_TARGET(Name \"command to run\")";
diff --git a/Source/cmAuxSourceDirectoryRule.h b/Source/cmAuxSourceDirectoryRule.h
index 9f9a0ec461..199e5bc7c4 100644
--- a/Source/cmAuxSourceDirectoryRule.h
+++ b/Source/cmAuxSourceDirectoryRule.h
@@ -59,7 +59,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add all the source files found in the specified\n"
"directory to the build.";
@@ -68,7 +68,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"AUX_SOURCE_DIRECTORY(dir)";
diff --git a/Source/cmExecutablesRule.h b/Source/cmExecutablesRule.h
index e30ce8ae27..8026a33fda 100644
--- a/Source/cmExecutablesRule.h
+++ b/Source/cmExecutablesRule.h
@@ -56,7 +56,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add a list of executables files.";
}
@@ -64,7 +64,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"EXECUTABLES(file1 file2 ...)";
diff --git a/Source/cmFindIncludeRule.h b/Source/cmFindIncludeRule.h
index 28da4ad2df..f9cd40e51d 100644
--- a/Source/cmFindIncludeRule.h
+++ b/Source/cmFindIncludeRule.h
@@ -63,7 +63,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Find an include path.";
}
@@ -71,7 +71,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"FIND_INCLUDE(DEFINE try1 try2 ...)";
diff --git a/Source/cmFindLibraryRule.h b/Source/cmFindLibraryRule.h
index 9f5f8dfe47..f8dc66e604 100644
--- a/Source/cmFindLibraryRule.h
+++ b/Source/cmFindLibraryRule.h
@@ -64,7 +64,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Find a library.";
}
@@ -72,7 +72,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"FIND_LIBRARY(DEFINE try1 try2)";
diff --git a/Source/cmFindProgramRule.h b/Source/cmFindProgramRule.h
index a94bb38ba0..97b954ac37 100644
--- a/Source/cmFindProgramRule.h
+++ b/Source/cmFindProgramRule.h
@@ -64,7 +64,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Find an executable program.";
}
@@ -72,7 +72,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"FIND_PROGRAM(NAME executable1 executable2 ...)";
diff --git a/Source/cmIncludeDirectoryRule.h b/Source/cmIncludeDirectoryRule.h
index 9d2980a8bb..ad7ce7ba84 100644
--- a/Source/cmIncludeDirectoryRule.h
+++ b/Source/cmIncludeDirectoryRule.h
@@ -62,7 +62,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add include directories to the build.";
}
@@ -70,7 +70,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"INCLUDE_DIRECTORIES(dir1 dir2 ...)";
diff --git a/Source/cmLibraryRule.h b/Source/cmLibraryRule.h
index 2a4ce2d50d..7bde5c0830 100644
--- a/Source/cmLibraryRule.h
+++ b/Source/cmLibraryRule.h
@@ -57,7 +57,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Set a name for a library.";
}
@@ -65,7 +65,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"LIBRARY(libraryname)";
diff --git a/Source/cmLinkDirectoriesRule.h b/Source/cmLinkDirectoriesRule.h
index b303187480..a46c39517d 100644
--- a/Source/cmLinkDirectoriesRule.h
+++ b/Source/cmLinkDirectoriesRule.h
@@ -64,7 +64,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Specify link directories.";
}
@@ -72,11 +72,11 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
- "Specify the paths to the libraries that will be linked in.\n"
"LINK_DIRECTORIES(directory1 directory2 ...)\n"
+ "Specify the paths to the libraries that will be linked in.\n"
"The directories can use built in definitions like \n"
"CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.";
}
diff --git a/Source/cmLinkLibrariesRule.h b/Source/cmLinkLibrariesRule.h
index a06bbf1cdd..5a80b899ec 100644
--- a/Source/cmLinkLibrariesRule.h
+++ b/Source/cmLinkLibrariesRule.h
@@ -63,17 +63,17 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return
- "Specify a list of libraries to be linked into executables or \n"
- "shared objects.";
+ "Specify a list of libraries to be linked into\n"
+ "executables or shared objects.";
}
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"LINK_LIBRARIES(library1 library2)\n"
diff --git a/Source/cmMakefile.cxx b/Source/cmMakefile.cxx
index 28e6030078..2ecab86b60 100644
--- a/Source/cmMakefile.cxx
+++ b/Source/cmMakefile.cxx
@@ -393,8 +393,8 @@ int cmMakefile::DumpDocumentationToFile(const char *fileName)
j != m_RuleMakers.end(); ++j)
{
name = (*j).second->GetName();
- terse = (*j).second->TerseDocumentation();
- full = (*j).second->FullDocumentation();
+ terse = (*j).second->GetTerseDocumentation();
+ full = (*j).second->GetFullDocumentation();
f << name << " - " << terse << std::endl
<< "Usage: " << full << std::endl << std::endl;
}
diff --git a/Source/cmProjectRule.h b/Source/cmProjectRule.h
index 0560ab120e..304bcb332c 100644
--- a/Source/cmProjectRule.h
+++ b/Source/cmProjectRule.h
@@ -57,7 +57,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Set a name for the entire project. One argument.";
}
@@ -65,11 +65,10 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
- "PROJECT(projectname)\n"
- "Set the name for the entire project. This takes one argument.";
+ "PROJECT(projectname)\n";
}
};
diff --git a/Source/cmRuleMaker.h b/Source/cmRuleMaker.h
index 818da4c7eb..b653c38d6a 100644
--- a/Source/cmRuleMaker.h
+++ b/Source/cmRuleMaker.h
@@ -81,12 +81,12 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation() = 0;
+ virtual const char* GetTerseDocumentation() = 0;
/**
* More documentation.
*/
- virtual const char* FullDocumentation() = 0;
+ virtual const char* GetFullDocumentation() = 0;
/**
* Enable the rule.
diff --git a/Source/cmSourceFilesRequireRule.h b/Source/cmSourceFilesRequireRule.h
index 81ed5d17be..ba8b2e3989 100644
--- a/Source/cmSourceFilesRequireRule.h
+++ b/Source/cmSourceFilesRequireRule.h
@@ -59,7 +59,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add a list of source files if the required \n"
"variables are set.";
@@ -68,7 +68,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"SOURCE_FILES_REQUIRE(var1 var2 ... SOURCES_BEGIN file1 file2 ...)";
diff --git a/Source/cmSourceFilesRule.h b/Source/cmSourceFilesRule.h
index c41b3a68fc..36fe3b9121 100644
--- a/Source/cmSourceFilesRule.h
+++ b/Source/cmSourceFilesRule.h
@@ -61,7 +61,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add a list of source files.";
}
@@ -69,7 +69,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"SOURCE_FILES(file1 file2 ...)";
diff --git a/Source/cmSubdirRule.h b/Source/cmSubdirRule.h
index ea26a59743..5b708c6a64 100644
--- a/Source/cmSubdirRule.h
+++ b/Source/cmSubdirRule.h
@@ -57,7 +57,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add a list of subdirectories to the build.";
}
@@ -65,7 +65,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"SUBDIRS(dir1 dir2 ...)\n"
diff --git a/Source/cmTestsRule.h b/Source/cmTestsRule.h
index 6ccfdab6df..cc1686c19f 100644
--- a/Source/cmTestsRule.h
+++ b/Source/cmTestsRule.h
@@ -60,7 +60,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add a list of executables files that are run as tests.";
}
@@ -68,7 +68,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"TESTS(file1 file2 ...)";
diff --git a/Source/cmUnixDefinesRule.h b/Source/cmUnixDefinesRule.h
index 86e488fba9..aa2e281014 100644
--- a/Source/cmUnixDefinesRule.h
+++ b/Source/cmUnixDefinesRule.h
@@ -67,7 +67,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add -D flags to the command line for Unix only.";
}
@@ -75,7 +75,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"UNIX_DEFINES(-DFOO -DBAR)\n"
diff --git a/Source/cmUnixLibrariesRule.h b/Source/cmUnixLibrariesRule.h
index fa04a2ba9e..41b6e4c2ad 100644
--- a/Source/cmUnixLibrariesRule.h
+++ b/Source/cmUnixLibrariesRule.h
@@ -67,7 +67,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add libraries that are only used for Unix programs.";
}
@@ -75,7 +75,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"UNIX_LIBRARIES(library -lm ...)";
diff --git a/Source/cmWin32DefinesRule.h b/Source/cmWin32DefinesRule.h
index fa03e4eaeb..4268a8ed6b 100644
--- a/Source/cmWin32DefinesRule.h
+++ b/Source/cmWin32DefinesRule.h
@@ -67,7 +67,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add -D define flags to command line for Win32 environments.";
}
@@ -75,7 +75,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"WIN32_DEFINES(-DFOO -DBAR ...)\n"
diff --git a/Source/cmWin32LibrariesRule.h b/Source/cmWin32LibrariesRule.h
index d08bc3f486..038295faf1 100644
--- a/Source/cmWin32LibrariesRule.h
+++ b/Source/cmWin32LibrariesRule.h
@@ -67,7 +67,7 @@ public:
/**
* Succinct documentation.
*/
- virtual const char* TerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Add libraries that are only used for Win32 programs.";
}
@@ -75,7 +75,7 @@ public:
/**
* More documentation.
*/
- virtual const char* FullDocumentation()
+ virtual const char* GetFullDocumentation()
{
return
"WIN32_LIBRARIES(library -lm ...)";
View Lorry Controller Status