ENH:Documentation and cleanups

1 files changed, 35 insertions, 6 deletions

diff --git a/Source/cmMakefileGenerator.h b/Source/cmMakefileGenerator.h
index f676cc6..2ab50e4 100644
--- a/Source/cmMakefileGenerator.h
+++ b/Source/cmMakefileGenerator.h
@@ -1,18 +1,47 @@
-#ifndef cmMakeFileGenerator_h
-#define cmMakeFileGenerator_h
+/*=========================================================================
+
+  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 cmMakefileGenerator_h
+#define cmMakefileGenerator_h
 
 #include "cmStandardIncludes.h"
 
 class cmMakefile;
-struct cmClassFile;
+class cmClassFile;
 
+/** \class cmMakefileGenerator
+ * \brief Provide an abstract interface for classes generating makefiles.
+ *
+ * Subclasses of this abstract class generate makefiles for various
+ * platforms.
+ */
 class cmMakefileGenerator
 {
 public:
-  // use the m_Makefile and the m_CustomRules and m_ExtraSourceFiles
-  // to generate the makefile
-  virtual void GenerateMakefile() = 0;
+  /**
+   * Set the cmMakefile instance from which to generate the makefile.
+   */
   void SetMakefile(cmMakefile*);
+
+  /**
+   * Generate the makefile using the m_Makefile, m_CustomRules, 
+   * and m_ExtraSourceFiles. All subclasses of cmMakefileGenerator
+   * must implement this method.
+   */
+  virtual void GenerateMakefile() = 0;
+
 protected:
   cmMakefile* m_Makefile;
 };