Commit cacd6d16 authored by Will Schroeder's avatar Will Schroeder

ENH:Tweaks to dump documentation

parent 85d16dbd
......@@ -91,7 +91,6 @@ Rules: (Generated with cmDumpDocumentation)
PROJECT - Set a name for the entire project. One argument.
Usage: PROJECT(projectname)
Set the name for the entire project. This takes one argument.
SOURCE_FILES - Add a list of source files.
Usage: SOURCE_FILES(file1 file2 ...)
......@@ -123,6 +122,7 @@ Rules: (Generated with cmDumpDocumentation)
WIN32_LIBRARIES - Add libraries that are only used for Win32 programs.
Usage: WIN32_LIBRARIES(library -lm ...)
USING / BUILDING WITH CMAKE
---------------------------
......
......@@ -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 ..)";
......
......@@ -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\")";
......
......@@ -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)";
......
......@@ -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 ...)";
......
......@@ -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 ...)";
......
......@@ -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)";
......
......@@ -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 ...)";
......
......@@ -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 ...)";
......
......@@ -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)";
......
......@@ -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.";
}
......
......@@ -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"
......
......@@ -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;
}
......
......@@ -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";
}
};
......
......@@ -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.
......
......@@ -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 ...)";
......
......@@ -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 ...)";
......
......@@ -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"
......
......@@ -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 ...)";
......
......@@ -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"
......
......@@ -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 ...)";
......
......@@ -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"
......
......@@ -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 ...)";
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment