summaryrefslogtreecommitdiffstats
path: root/Source/cmCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2006-08-31 17:20:12 (GMT)
committerBrad King <brad.king@kitware.com>2006-08-31 17:20:12 (GMT)
commitf12742d6cdffd62378a4bbf8eeff0c552d2d9093 (patch)
tree47d6106c36cff7c570473b9cf41ed53a2cbbf443 /Source/cmCommand.h
parent2b33498c03877157faaacaa06f1a5e865b7d8537 (diff)
downloadCMake-f12742d6cdffd62378a4bbf8eeff0c552d2d9093.zip
CMake-f12742d6cdffd62378a4bbf8eeff0c552d2d9093.tar.gz
CMake-f12742d6cdffd62378a4bbf8eeff0c552d2d9093.tar.bz2
ENH: Patch from Alex to add IsDiscouraged method for future use in generating separate documentation for old commands. Also modified documentation of MAKE_DIRECTORY and REMOVE commands to indicate they should not be used.
Diffstat (limited to 'Source/cmCommand.h')
-rw-r--r--Source/cmCommand.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/Source/cmCommand.h b/Source/cmCommand.h
index 7466bb5..55672a6 100644
--- a/Source/cmCommand.h
+++ b/Source/cmCommand.h
@@ -102,6 +102,15 @@ public:
}
/**
+ * This determines if usage of the method is discouraged or not.
+ * This is currently only used for generating the documentation.
+ */
+ virtual bool IsDiscouraged()
+ {
+ return false;
+ }
+
+ /**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() = 0;