ENH:Beginning clean up; adding documentation

2 files changed, 103 insertions, 20 deletions

diff --git a/Source/cmExecutablesRule.h b/Source/cmExecutablesRule.h
index eb61c1e..e30ce8a 100644
--- a/Source/cmExecutablesRule.h
+++ b/Source/cmExecutablesRule.h
@@ -1,37 +1,75 @@
+/*=========================================================================
+
+  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 cmExecutablesRule_h
 #define cmExecutablesRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
+/** \class cmExecutablesRule
+ * \brief Defines a list of executables to build.
+ *
+ * cmExecutablesRule defines a list of executable (i.e., test)
+ * programs to create.
+ */
 class cmExecutablesRule : public cmRuleMaker
 {
 public:
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() 
     {
-      return new cmExecutablesRule;
+    return new cmExecutablesRule;
     }
-  // 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);
+
+  /**
+   * 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 "EXECUTABLES";}
+
+  /**
+   * Succinct documentation.
+   */
   virtual const char* TerseDocumentation() 
     {
-      return "Add a list of executables files.";
+    return "Add a list of executables files.";
     }
   
-  // Return full documentation for the rule
+  /**
+   * More documentation.
+   */
   virtual const char* FullDocumentation()
     {
-      return
-        "EXECUTABLES(file1 file2 ...)";
+    return
+      "EXECUTABLES(file1 file2 ...)";
     }
 };
 
 
-
 #endif
diff --git a/Source/cmFindIncludeRule.h b/Source/cmFindIncludeRule.h
index 654c26a..c2563d9 100644
--- a/Source/cmFindIncludeRule.h
+++ b/Source/cmFindIncludeRule.h
@@ -1,35 +1,80 @@
+/*=========================================================================
+
+  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 cmFindIncludeRule_h
 #define cmFindIncludeRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
+/** \class cmFindIncludeRule
+ * \brief Define a rule that searches for an include file.
+ *
+ * cmFindIncludeRule is used to define a variable include
+ * path location by specifying a file and list of directories.
+ */
 class cmFindIncludeRule : public cmRuleMaker
 {
 public:
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() 
     {
-      return new cmFindIncludeRule;
+    return new cmFindIncludeRule;
     }
-  // 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);
+  
+  /**
+   * This is called at the end after all the information
+   * specified by the rules is accumulated.
+   */
   virtual void FinalPass() { }
-  virtual bool IsInherited() { return true;  }
 
-  // This is the name used in the input file.
+  /**
+   * This determines if the rule gets propagated down
+   * to makefiles located in subdirectories.
+   */
+  virtual bool IsInherited() 
+    {return true;}
+
+  /**
+   * The name of the rule as specified in CMakeList.txt.
+   */
   virtual const char* GetName() { return "FIND_INCLUDE";}
+
+  /**
+   * Succinct documentation.
+   */
   virtual const char* TerseDocumentation() 
     {
-      return "Find an include path.";
+    return "Find an include path.";
     }
   
-  // Return full documentation for the rule
+  /**
+   * More documentation.
+   */
   virtual const char* FullDocumentation()
     {
-      return
-        "FIND_INCLUDE(DEFINE try1 try2 ...);";
+    return
+      "FIND_INCLUDE(DEFINE try1 try2 ...);";
     }
 };