ENH:Beginning clean up; adding documentation

1 files changed, 38 insertions, 8 deletions

diff --git a/Source/cmAbstractFilesRule.h b/Source/cmAbstractFilesRule.h
index 9d22372..717dd6d 100644
--- a/Source/cmAbstractFilesRule.h
+++ b/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 ..)";