diff options
author | Brad King <brad.king@kitware.com> | 2013-10-16 13:28:12 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-16 13:28:12 (GMT) |
commit | c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch) | |
tree | 96102c69673467ce7b922697cd5f378511249201 /Source/cmVariableRequiresCommand.h | |
parent | 5029da5eac08171653a92b961c341f7ffcca3640 (diff) | |
parent | 7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff) | |
download | CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2 |
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...
Diffstat (limited to 'Source/cmVariableRequiresCommand.h')
-rw-r--r-- | Source/cmVariableRequiresCommand.h | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h index c86f43d..1032745 100644 --- a/Source/cmVariableRequiresCommand.h +++ b/Source/cmVariableRequiresCommand.h @@ -41,34 +41,6 @@ public: */ virtual const char* GetName() const { return "variable_requires";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the if() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Assert satisfaction of an option's required variables.\n" - " variable_requires(TEST_VARIABLE RESULT_VARIABLE\n" - " REQUIRED_VARIABLE1\n" - " REQUIRED_VARIABLE2 ...)\n" - "The first argument (TEST_VARIABLE) is the name of the variable to be " - "tested, if that variable is false nothing else is done. If " - "TEST_VARIABLE is true, then " - "the next argument (RESULT_VARIABLE) is a variable that is set to true " - "if all the required variables are set. " - "The rest of the arguments are variables that must be true or not " - "set to NOTFOUND to avoid an error. If any are not true, an error " - "is reported."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { |