summaryrefslogtreecommitdiffstats
path: root/Source/cmake.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmake.h')
-rw-r--r--Source/cmake.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/Source/cmake.h b/Source/cmake.h
index 6b1f756..1abb1e8 100644
--- a/Source/cmake.h
+++ b/Source/cmake.h
@@ -239,7 +239,16 @@ class cmake
///! Get the variable watch object
cmVariableWatch* GetVariableWatch() { return this->VariableWatch; }
- void GetCommandDocumentation(std::vector<cmDocumentationEntry>&) const;
+ /** Get the documentation entries for the supported commands.
+ * If withCurrentCommands is true, the documentation for the
+ * recommended set of commands is included.
+ * If withCompatCommands is true, the documentation for discouraged
+ * (compatibility) commands is included.
+ * You probably don't want to set both to false.
+ */
+ void GetCommandDocumentation(std::vector<cmDocumentationEntry>& entries,
+ bool withCurrentCommands = true,
+ bool withCompatCommands = true) const;
void GetPropertiesDocumentation(std::vector<cmDocumentationEntry>&);
void GetGeneratorDocumentation(std::vector<cmDocumentationEntry>&);