From cacd6d160410660bcbc27f02b267833448c1eef1 Mon Sep 17 00:00:00 2001
From: Will Schroeder <will.schroeder@kitware.com>
Date: Fri, 12 Jan 2001 14:35:15 -0500
Subject: [PATCH] ENH:Tweaks to dump documentation

---
 README                            | 2 +-
 Source/cmAbstractFilesRule.h      | 4 ++--
 Source/cmAddTargetRule.h          | 4 ++--
 Source/cmAuxSourceDirectoryRule.h | 4 ++--
 Source/cmExecutablesRule.h        | 4 ++--
 Source/cmFindIncludeRule.h        | 4 ++--
 Source/cmFindLibraryRule.h        | 4 ++--
 Source/cmFindProgramRule.h        | 4 ++--
 Source/cmIncludeDirectoryRule.h   | 4 ++--
 Source/cmLibraryRule.h            | 4 ++--
 Source/cmLinkDirectoriesRule.h    | 6 +++---
 Source/cmLinkLibrariesRule.h      | 8 ++++----
 Source/cmMakefile.cxx             | 4 ++--
 Source/cmProjectRule.h            | 7 +++----
 Source/cmRuleMaker.h              | 4 ++--
 Source/cmSourceFilesRequireRule.h | 4 ++--
 Source/cmSourceFilesRule.h        | 4 ++--
 Source/cmSubdirRule.h             | 4 ++--
 Source/cmTestsRule.h              | 4 ++--
 Source/cmUnixDefinesRule.h        | 4 ++--
 Source/cmUnixLibrariesRule.h      | 4 ++--
 Source/cmWin32DefinesRule.h       | 4 ++--
 Source/cmWin32LibrariesRule.h     | 4 ++--
 23 files changed, 49 insertions(+), 50 deletions(-)

diff --git a/README b/README
index 113b038ef..0d3f153d3 100644
--- a/README
+++ b/README
@@ -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
 ---------------------------
 
diff --git a/Source/cmAbstractFilesRule.h b/Source/cmAbstractFilesRule.h
index 717dd6ddf..5eb51fca1 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 6272c3278..65d57e8c9 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 9f9a0ec46..199e5bc7c 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 e30ce8ae2..8026a33fd 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 28da4ad2d..f9cd40e51 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 9f5f8dfe4..f8dc66e60 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 a94bb38ba..97b954ac3 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 9d2980a8b..ad7ce7ba8 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 2a4ce2d50..7bde5c083 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 b30318748..a46c39517 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 a06bbf1cd..5a80b899e 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 28e603007..2ecab86b6 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 0560ab120..304bcb332 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 818da4c7e..b653c38d6 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 81ed5d17b..ba8b2e398 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 c41b3a68f..36fe3b912 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 ea26a5974..5b708c6a6 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 6ccfdab6d..cc1686c19 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 86e488fba..aa2e28101 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 fa04a2ba9..41b6e4c2a 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 fa03e4eae..4268a8ed6 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 d08bc3f48..038295faf 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 ...)";