diff options
Diffstat (limited to 'Source/cmLibraryRule.h')
-rw-r--r-- | Source/cmLibraryRule.h | 56 |
1 files changed, 48 insertions, 8 deletions
diff --git a/Source/cmLibraryRule.h b/Source/cmLibraryRule.h index 61db5e7..2a4ce2d 100644 --- a/Source/cmLibraryRule.h +++ b/Source/cmLibraryRule.h @@ -1,3 +1,18 @@ +/*========================================================================= + + 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 cmLibraryRule_h #define cmLibraryRule_h @@ -5,30 +20,55 @@ #include "cmRuleMaker.h" +/** \class cmLibraryRule + * \brief Specify a name for a library. + * + * cmLibraryRule is used to specify the name of a library to be + * generated by the build process. + */ class cmLibraryRule : public cmRuleMaker { public: + /** + * This is a virtual constructor for the rule. + */ virtual cmRuleMaker* Clone() { - return new cmLibraryRule; + return new cmLibraryRule; } - // 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 "LIBRARY";} + + /** + * Succinct documentation. + */ virtual const char* TerseDocumentation() { - return "Set a name for the Library."; + return "Set a name for a library."; } - // Return full documentation for the rule + /** + * More documentation. + */ virtual const char* FullDocumentation() { - return - "LIBRARY(libraryname);"; + return + "LIBRARY(libraryname)"; } }; |