1 files changed, 51 insertions, 11 deletions

diff --git a/Source/cmProjectRule.h b/Source/cmProjectRule.h
index 22ebf61..ef9cb2d 100644
--- a/Source/cmProjectRule.h
+++ b/Source/cmProjectRule.h
@@ -1,35 +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 cmProjectRule_h
 #define cmProjectRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
+/** \class cmProjectRule
+ * \brief Specify the name for this build project.
+ *
+ * cmProjectRule is used to specify a name for this build project.
+ * It is defined once per set of CMakeList.txt files (including
+ * all subdirectories).
+ */
 class cmProjectRule : public cmRuleMaker
 {
 public:
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() 
     {
-      return new cmProjectRule;
+    return new cmProjectRule;
     }
-  // 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.
-  virtual const char* GetName() { return "PROJECT";}
+  /**
+   * The name of the rule as specified in CMakeList.txt.
+   */
+  virtual const char* GetName() {return "PROJECT";}
+
+  /**
+   * Succinct documentation.
+   */
   virtual const char* TerseDocumentation() 
     {
-      return "Set a name for the entire project. One argument.";
+    return "Set a name for the entire project. One argument.";
     }
   
-  // Return full documentation for the rule
+  /**
+   * More documentation.
+   */
   virtual const char* FullDocumentation()
     {
-      return
-        "Set the name for the entire project.  This takes one argument.\n"
-        "PROJECT(projectname);";
+    return
+      "Set the name for the entire project.  This takes one argument.\n"
+      "PROJECT(projectname)";
     }
 };