ENH:Beginning clean up; adding documentation

Source/cmAbstractFilesRule.h

@@ -1,10 +1,24 @@
+/*=========================================================================
+
+  Program:   Insight Segmentation & Registration Toolkit
+  Module:    $RCSfile$
+  Language:  C++
+  Date:      $Date$
+  Version:   $Revision$
+
+
+  Copyright (c) 2000 National Library of Medicine
+  All rights reserved.
+
+  See COPYRIGHT.txt for copyright details.
+
+=========================================================================*/
 #ifndef cmAbstractFilesRule_h
 #define cmAbstractFilesRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
 class cmAbstractFilesRule : public cmRuleMaker
 {
 public:
@@ -12,20 +26,36 @@ public:
     {
       return new cmAbstractFilesRule;
     }
-  // This is called when the rule is firt encountered in
+
-  // the input file
+  /**
+   * This is called when the rule is first encountered in
+   * the input file.
+   */
   virtual bool Invoke(std::vector<std::string>& args);
+
+  /**
+   * This is called at the end after all the information
+   * specified by the rules is accumulated.
+   */
   virtual void FinalPass() { }
   
-  // This is the name used in the input file.
+  /**
+   * The name of the rule as specified in CMakeList.txt.
+   */
   virtual const char* GetName() { return "ABSTRACT_FILES";}
-  virtual const char* TerseDocumentaion() 
+
+  /**
+   * Succinct documentation.
+   */
+  virtual const char* TerseDocumentation() 
     {
-      return "A list of abstract classes, useful for wrappers.";
+    return "A list of abstract classes, useful for wrappers.";
     }
   
-  // Return full documentation for the rule
+  /**
-  virtual const char* FullDocumentaion()
+   * Longer documentation.
+   */
+  virtual const char* FullDocumentation()
     {
       return
         "ABSTRACT_FILES(file1 file2 ..)";

Source/cmAddTargetRule.h

@@ -1,37 +1,76 @@
+/*=========================================================================
+
+  Program:   Insight Segmentation & Registration Toolkit
+  Module:    $RCSfile$
+  Language:  C++
+  Date:      $Date$
+  Version:   $Revision$
+
+
+  Copyright (c) 2000 National Library of Medicine
+  All rights reserved.
+
+  See COPYRIGHT.txt for copyright details.
+
+=========================================================================*/
 #ifndef cmAddTargetRule_h
 #define cmAddTargetRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
+/** \class cmAddTargetRule
+ * \brief Rule that adds a target to the build system.
+ *
+ * cmAddTargetRule adds an extra target to the build system.
+ * This is useful when you would like to add special
+ * targets like "install,", "clean," and so on.
+ */
 class cmAddTargetRule : public cmRuleMaker
 {
 public:
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() 
     {
-      return new cmAddTargetRule;
+    return new cmAddTargetRule;
     }
-  // This is called when the rule is firt encountered in
+
-  // the input file
+  /**
+   * This is called when the rule is first encountered in
+   * the CMakeLists.txt file.
+   */
   virtual bool Invoke(std::vector<std::string>& args);
-  virtual void FinalPass() { }
   
-  // This is the name used in the input file.
+  /**
-  virtual const char* GetName() { return "ADD_TARGET";}
+   * This is called at the end after all the information
-  virtual const char* TerseDocumentaion() 
+   * specified by the rules is accumulated.
+   */
+  virtual void FinalPass() {}
+  
+  /**
+   * The name of the rule as specified in CMakeList.txt.
+   */
+  virtual const char* GetName() 
+    {return "ADD_TARGET";}
+  
+  /**
+   * Succinct documentation.
+   */
+  virtual const char* TerseDocumentation() 
     {
-      return "Add an extra target to the build system.";
+    return "Add an extra target to the build system.";
     }
   
-  // Return full documentation for the rule
+  /**
-  virtual const char* FullDocumentaion()
+   * More documentation.
+   */
+  virtual const char* FullDocumentation()
     {
-      return
+    return
-        "ADD_TARGET(Name \"command to run\");";
+      "ADD_TARGET(Name \"command to run\");";
     }
 };
 
-
-
 #endif

Source/cmAuxSourceDirectoryRule.h

@@ -19,14 +19,14 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "AUX_SOURCE_DIRECTORY";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add all the source files found in the specified directory to\n"
         " the build.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "AUX_SOURCE_DIRECTORY(dir)";

Source/cmDSPMakefile.h

@@ -13,33 +13,47 @@
   See COPYRIGHT.txt for copyright details.
 
 =========================================================================*/
-/**
- * cmDSPMakefile generate a microsoft DSP project file.
- * see the *.dsptemplate files for information on the templates
- * used for making the project files.
- */
 #ifndef cmDSPMakefile_h
 #define cmDSPMakefile_h
+
 #include "cmStandardIncludes.h"
 #include "cmMakefile.h"
 
+/** \class cmDSPMakefile
+ * \brief Generate a Microsoft DSP project file.
+ *
+ * cmDSPMakefile generates a Microsoft DSP project file.
+ * See the *.dsptemplate files for information on the templates
+ * used for making the project files.
+ */
 class cmDSPMakefile 
 {
 public:
   cmDSPMakefile(cmMakefile*);
   ~cmDSPMakefile();
   void OutputDSPFile();
-  enum BuildType { STATIC_LIBRARY, DLL, EXECUTABLE };
+  enum BuildType {STATIC_LIBRARY, DLL, EXECUTABLE};
-  void SetBuildType(BuildType );
+
-  // return array of created DSP names
+  /**
-  // Each executable must have its own dsp
+   * Specify the type of the build: static, dll, or executable.
+   */
+  void SetBuildType(BuildType);
+
+  /**
+   * Return array of created DSP names in a STL vector.
+   * Each executable must have its own dsp.
+   */
   std::vector<std::string> GetCreatedProjectNames() 
     {
-      return m_CreatedProjectNames;
+    return m_CreatedProjectNames;
     }
+
+  /**
+   * Return the makefile.
+   */
   cmMakefile* GetMakefile() 
     {
-      return m_Makefile;
+    return m_Makefile;
     }
   
 private:
@@ -63,7 +77,7 @@ private:
 		       const char* source,
 		       const char* result,
 		       const char* command);
-private:
+
   std::string m_IncludeOptions;
   std::string m_DebugLibraryOptions;
   std::string m_ReleaseLibraryOptions;

Source/cmDSPWriter.h

@@ -13,33 +13,47 @@
   See COPYRIGHT.txt for copyright details.
 
 =========================================================================*/
-/**
- * cmDSPMakefile generate a microsoft DSP project file.
- * see the *.dsptemplate files for information on the templates
- * used for making the project files.
- */
 #ifndef cmDSPMakefile_h
 #define cmDSPMakefile_h
+
 #include "cmStandardIncludes.h"
 #include "cmMakefile.h"
 
+/** \class cmDSPMakefile
+ * \brief Generate a Microsoft DSP project file.
+ *
+ * cmDSPMakefile generates a Microsoft DSP project file.
+ * See the *.dsptemplate files for information on the templates
+ * used for making the project files.
+ */
 class cmDSPMakefile 
 {
 public:
   cmDSPMakefile(cmMakefile*);
   ~cmDSPMakefile();
   void OutputDSPFile();
-  enum BuildType { STATIC_LIBRARY, DLL, EXECUTABLE };
+  enum BuildType {STATIC_LIBRARY, DLL, EXECUTABLE};
-  void SetBuildType(BuildType );
+
-  // return array of created DSP names
+  /**
-  // Each executable must have its own dsp
+   * Specify the type of the build: static, dll, or executable.
+   */
+  void SetBuildType(BuildType);
+
+  /**
+   * Return array of created DSP names in a STL vector.
+   * Each executable must have its own dsp.
+   */
   std::vector<std::string> GetCreatedProjectNames() 
     {
-      return m_CreatedProjectNames;
+    return m_CreatedProjectNames;
     }
+
+  /**
+   * Return the makefile.
+   */
   cmMakefile* GetMakefile() 
     {
-      return m_Makefile;
+    return m_Makefile;
     }
   
 private:
@@ -63,7 +77,7 @@ private:
 		       const char* source,
 		       const char* result,
 		       const char* command);
-private:
+
   std::string m_IncludeOptions;
   std::string m_DebugLibraryOptions;
   std::string m_ReleaseLibraryOptions;

Source/cmExecutablesRule.h

@@ -19,13 +19,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "EXECUTABLES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add a list of executables files.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "EXECUTABLES(file1 file2 ...)";

Source/cmFindIncludeRule.h

@@ -20,13 +20,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "FIND_INCLUDE";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Find an include path.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "FIND_INCLUDE(DEFINE try1 try2 ...);";

Source/cmFindLibraryRule.h

@@ -20,13 +20,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "FIND_LIBRARY";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Set a name for the entire project. One argument.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "FIND_LIBRARY(DEFINE try1 try2);";

Source/cmFindProgramRule.h

@@ -20,13 +20,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "FIND_PROGRARM";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "not implemented.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "not implemented.\n"

Source/cmIncludeDirectoryRule.h

@@ -20,13 +20,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "INCLUDE_DIRECTORIES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add include directories to the build.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "INCLUDE_DIRECTORIES(dir1 dir2 ...).\n";

Source/cmLibraryRule.h

@@ -19,13 +19,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "LIBRARY";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Set a name for the Library.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "LIBRARY(libraryname);";

Source/cmLinkDirectoriesRule.h

@@ -21,13 +21,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "LINK_DIRECTORIES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Specify link directories.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Specify the paths to the libraries that will be linked in.\n"

Source/cmLinkLibrariesRule.h

@@ -21,7 +21,7 @@ public:
     
   // This is the name used in the input file.
   virtual const char* GetName() { return "LINK_LIBRARIES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return 
         "Specify a list of libraries to be linked into executables or \n"
@@ -29,7 +29,7 @@ public:
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Specify a list of libraries to be linked into executables or \n"

Source/cmProjectRule.h

@@ -19,13 +19,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "PROJECT";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Set a name for the entire project. One argument.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Set the name for the entire project.  This takes one argument.\n"

Source/cmRuleMaker.h

@@ -1,52 +1,129 @@
+/*=========================================================================
+
+  Program:   Insight Segmentation & Registration Toolkit
+  Module:    $RCSfile$
+  Language:  C++
+  Date:      $Date$
+  Version:   $Revision$
+
+
+  Copyright (c) 2000 National Library of Medicine
+  All rights reserved.
+
+  See COPYRIGHT.txt for copyright details.
+
+=========================================================================*/
 #ifndef cmRuleMaker_h
 #define cmRuleMaker_h
+
 #include "cmStandardIncludes.h"
 #include "cmMakefile.h"
 
+/** \class cmRuleMaker
+ * \brief Superclass for all rules in CMake.
+ *
+ * cmRuleMaker is the base class for all rules in CMake.
+ * cmRuleMaker defines the API for rules with such features
+ * as enable/disable, inheritance, documentation, and construction.
+ */
 class cmRuleMaker
 {
 public:
-  cmRuleMaker()  {  m_Makefile = 0; m_Enabled = true; }
+  /**
-  void SetMakefile(cmMakefile*m) {m_Makefile = m; }
+   * Construct the rule enabled with no makefile.
-  // This is called when the rule is firt encountered in
+   * the input file.
-  // the input file
+   */
+  cmRuleMaker()  
+    {m_Makefile = 0; m_Enabled = true;}
+
+  /**
+   * Specify the makefile.
+   */
+  void SetMakefile(cmMakefile*m) 
+    {m_Makefile = m; }
+
+  /**
+   * This is called when the rule is first encountered in
+   * the CMakeLists.txt file.
+   */
   virtual bool Invoke(std::vector<std::string>& args) = 0;
-  // This is called after the entire file has been parsed.
+
+  /**
+   * This is called at the end after all the information
+   * specified by the rules is accumulated.
+   */
   virtual void FinalPass() = 0;
-  // This is called to let the rule check the cache
+
-  virtual void LoadCache() {  }
+  /**
+   * This is called to let the rule check the cache.
+   */
+  virtual void LoadCache() {}
   
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() = 0;
   
-  // This determines if the rule gets passed down
+  /**
-  // to sub directory makefiles
+   * This determines if the rule gets propagated down
+   * to makefiles located in subdirectories.
+   */
   virtual bool IsInherited() 
     {
-      return false;
+    return false;
     }
-  // This is the name used in the input file.
+
+  /**
+   * The name of the rule as specified in CMakeList.txt.
+   */
   virtual const char* GetName() = 0;
-  // Return the terse documentaion for the rule
+
-  virtual const char* TerseDocumentaion() = 0;
+  /**
-  // Return full documentation for the rule
+   * Succinct documentation.
-  virtual const char* FullDocumentaion() = 0;
+   */
-  // enable or disable this rule
+  virtual const char* TerseDocumentation() = 0;
-  bool GetEnabled()  { return m_Enabled; }
+
-  void SetEnableOn() { m_Enabled = true; }
+  /**
-  void SetEnableOff() {  m_Enabled = false; }
+   * More documentation.
-  const char* GetError() { return m_Error.c_str();}
+   */
+  virtual const char* FullDocumentation() = 0;
+
+  /**
+   * Enable the rule.
+   */
+  void EnabledOn() 
+    {m_Enabled = true;}
+
+  /**
+   * Disable the rule.
+   */
+  void EnabledOff() 
+    {m_Enabled = false;}
+
+  /**
+   * Query whether the rule is enabled.
+   */
+  bool GetEnabled()  
+    {return m_Enabled;}
+
+  /**
+   * Return the last error string.
+   */
+  const char* GetError() 
+    {return m_Error.c_str();}
+
 protected:
   void SetError(const char* e)
     {
-      m_Error = this->GetName();
+    m_Error = this->GetName();
-      m_Error += " ";
+    m_Error += " ";
-      m_Error += e;
+    m_Error += e;
     }
   cmMakefile* m_Makefile;
+
 private:
   bool m_Enabled;
   std::string m_Error;
 };
 
-
 #endif

Source/cmSourceFilesRequireRule.h

@@ -19,13 +19,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "SOURCE_FILES_REQUIRE";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add a list of source files.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "SOURCE_FILES(file1 file2 ...)";

Source/cmSourceFilesRule.h

@@ -19,13 +19,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "SOURCE_FILES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add a list of source files.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "SOURCE_FILES(file1 file2 ...)";

Source/cmSubdirRule.h

@@ -19,13 +19,13 @@ public:
   
   // This is the name used in the input file.
   virtual const char* GetName() { return "SUBDIRS";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add a list of subdirectories to the build.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Add a list of subdirectories to the build.\n"

Source/cmTestsRule.h

@@ -19,13 +19,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "TESTS";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add a list of executables files that are run as tests.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "TESTS(file1 file2 ...)";

Source/cmUnixDefinesRule.cxx

@@ -3,7 +3,7 @@
 cmUnixDefinesRule::cmUnixDefinesRule()
 {
 #if defined(_WIN32) && !defined(__CYGWIN__)
-  this->SetEnableOff();
+  this->EnabledOff();
 #endif
 }
 

Source/cmUnixDefinesRule.h

@@ -21,13 +21,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "UNIX_DEFINES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add -D flags to the command line for unix only.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Add -D flags to the command line for unix only.\n"

Source/cmUnixLibrariesRule.cxx

@@ -3,7 +3,7 @@
 cmUnixLibrariesRule::cmUnixLibrariesRule()
 {
 #if defined(_WIN32) && !defined(__CYGWIN__)
-  this->SetEnableOff();
+  this->EnabledOff();
 #endif
 }
 

Source/cmUnixLibrariesRule.h

@@ -21,13 +21,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "UNIX_LIBRARIES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add libraries that are only used for unix programs.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "UNIX_LIBRARIES(library -lm ...);";

Source/cmWin32DefinesRule.h

@@ -20,13 +20,13 @@ public:
   virtual bool IsInherited() { return true;  }
   // This is the name used in the input file.
   virtual const char* GetName() { return "WIN32_DEFINES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Add -D define flags to command line for win32 environments.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Add -D define flags to command line for win32 environments.\n"

Source/cmWin32LibrariesRule.h

@@ -21,13 +21,13 @@ public:
 
   // This is the name used in the input file.
   virtual const char* GetName() { return "WIN32_LIBRARIES";}
-  virtual const char* TerseDocumentaion() 
+  virtual const char* TerseDocumentation() 
     {
       return "Set a name for the library to be built. One argument.";
     }
   
   // Return full documentation for the rule
-  virtual const char* FullDocumentaion()
+  virtual const char* FullDocumentation()
     {
       return
         "Set the name for the library in this makefile.  \n"