ENH:Added documentation; clean-up

1 files changed, 59 insertions, 11 deletions

diff --git a/Source/cmUnixLibrariesRule.h b/Source/cmUnixLibrariesRule.h
index 8b8d5e0..fa04a2b 100644
--- a/Source/cmUnixLibrariesRule.h
+++ b/Source/cmUnixLibrariesRule.h
@@ -1,36 +1,84 @@
+/*=========================================================================
+
+  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 cmUnixLibrariesRule_h
 #define cmUnixLibrariesRule_h
 
 #include "cmStandardIncludes.h"
 #include "cmRuleMaker.h"
 
-
+/** \class cmUnixLibrariesRule
+ * \brief Specify a list of libraries for Unix platforms.
+ *
+ * cmUnixLibrariesRule specifies a list of libraries for Unix platforms
+ * only. Both user and system libraries can be listed.
+ */
 class cmUnixLibrariesRule : public cmRuleMaker
 {
 public:
+  /**
+   * Constructor.
+   */
   cmUnixLibrariesRule();
+
+  /**
+   * This is a virtual constructor for the rule.
+   */
   virtual cmRuleMaker* Clone() 
     {
-      return new cmUnixLibrariesRule;
+    return new cmUnixLibrariesRule;
     }
-  // 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.
-  virtual const char* GetName() { return "UNIX_LIBRARIES";}
+  /**
+   * 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 "UNIX_LIBRARIES";}
+
+  /**
+   * Succinct documentation.
+   */
   virtual const char* TerseDocumentation() 
     {
-      return "Add libraries that are only used for unix programs.";
+    return "Add libraries that are only used for Unix programs.";
     }
   
-  // Return full documentation for the rule
+  /**
+   * More documentation.
+   */
   virtual const char* FullDocumentation()
     {
-      return
-        "UNIX_LIBRARIES(library -lm ...);";
+    return
+      "UNIX_LIBRARIES(library -lm ...)";
     }
 };